openstack/deb-python-oauth2client
Code Issues Proposed changes

Transition oauth2client from googlecode to github.

Browse Source
This commit is contained in:
John Asmuth
2014-04-24 15:46:03 -04:00
parent 3aaca548a7
commit c55dc07f1a
952 changed files with 148 additions and 181419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
FAQ
View File

@@ -1,8 +0,0 @@
Frequently asked questions?
Q: How do I work out the arguments and methods that are available for a particular API?
A: http://api-python-client-doc.appspot.com/ has dynamically generated
documentation for all the APIs supported by this library.

6
MANIFEST.in
View File

@@ -1,7 +1 @@
recursive-include uritemplate *.py
recursive-include apiclient *.json *.py
include CHANGELOG
include LICENSE
include README
include FAQ
include setpath.sh

1
MANIFEST_oauth2client.in
View File

@@ -1 +0,0 @@
include README

49
Makefile
View File

@@ -15,64 +15,23 @@ coverage:
.PHONY: docs
docs:
cd docs; ./build.sh
python describe.py
python samples-index.py > ../google-api-python-client.wiki/SampleApps.wiki
.PHONY: wiki
wiki:
python samples-index.py > ../google-api-python-client.wiki/SampleApps.wiki
cd docs; ./build
.PHONY: prerelease
prerelease: test
-rm -rf dist/
-sudo rm -rf dist/
-rm -rf snapshot/
-sudo rm -rf snapshot/
./tools/gae-zip-creator.sh
python expandsymlinks.py
cd snapshot; python setup.py clean
cd snapshot; python setup.py sdist --formats=gztar,zip
cd snapshot; tar czf google-api-python-client-samples-$(shell python setup.py --version).tar.gz samples
cd snapshot; zip -r google-api-python-client-samples-$(shell python setup.py --version).zip samples
.PHONY: release
release: prerelease
@echo "This target will upload a new release to PyPi and code.google.com hosting."
@echo "Are you sure you want to proceed? (yes/no)"
@read yn; if [ yes -ne $(yn) ]; then exit 1; fi
@echo "Here we go..."
cd snapshot; python setup.py sdist --formats=gztar,zip register upload
wget "http://support.googlecode.com/svn/trunk/scripts/googlecode_upload.py" -O googlecode_upload.py
python googlecode_upload.py --summary="google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.tar.gz
python googlecode_upload.py --summary="google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.zip
python googlecode_upload.py --summary="Full Dependecies Build for Google App Engine Projects Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/gae/*.zip
python googlecode_upload.py --summary="Samples for google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/google-api-python-client-samples-*.tar.gz
python googlecode_upload.py --summary="Samples for google-api-python-client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/google-api-python-client-samples-*.zip
.PHONY: oauth2_prerelease
oauth2_prerelease: test
-rm -rf dist/
-sudo rm -rf dist/
-rm -rf snapshot/
-sudo rm -rf snapshot/
mkdir snapshot
python expandsymlinks.py --source=oauth2client --dest=snapshot/oauth2client
python expandsymlinks.py --source=uritemplate --dest=snapshot/uritemplate
cp setup_oauth2client.py snapshot/setup.py
cp MANIFEST_oauth2client.in snapshot/MANIFEST.in
cp README_oauth2client snapshot/README
python expandsymlinks.py
cd snapshot; python setup.py clean
cd snapshot; python setup.py sdist --formats=gztar,zip
.PHONY: oauth2_release
.PHONY: release
oauth2_release: oauth2_prerelease
@echo "This target will upload a new release to PyPi and code.google.com hosting."
@echo "This target will upload a new release to PyPi."
@echo "Are you sure you want to proceed? (yes/no)"
@read yn; if [ yes -ne $(yn) ]; then exit 1; fi
@echo "Here we go..."
cd snapshot; python setup.py sdist --formats=gztar,zip register upload
wget "http://support.googlecode.com/svn/trunk/scripts/googlecode_upload.py" -O googlecode_upload.py
python googlecode_upload.py --summary="oauth2client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.tar.gz
python googlecode_upload.py --summary="oauth2client Version $(shell python setup.py --version)" --project=google-api-python-client snapshot/dist/*.zip

16
README
View File

@@ -1,18 +1,12 @@
This is python client library for Google's discovery based APIs.
This is a client library for accessing resources protected by OAuth 2.0.
Installation
============
To install, simply use pip or easy_install:
To install, simply say
$ pip --upgrade google-api-python-client
$ easy_install --upgrade google-api-python-client
See the Developers Guide for more detailed instructions and documentation:
https://developers.google.com/api-client-library/python/start/get_started
$ easy_install --upgrade oauth2client
Third Party Libraries
@@ -21,12 +15,8 @@ Third Party Libraries
These libraries will be installed when you install the client library:
http://code.google.com/p/httplib2
http://code.google.com/p/uri-templates
Depending on your version of Python, these libraries may also be installed:
http://pypi.python.org/pypi/simplejson/
For development you will also need:
http://pythonpaste.org/webtest/

22
README_oauth2client
View File

@@ -1,22 +0,0 @@
This is a client library for accessing resources protected by OAuth 2.0.
Installation
============
To install, simply say
$ easy_install --upgrade oauth2client
Third Party Libraries
=====================
These libraries will be installed when you install the client library:
http://code.google.com/p/httplib2
Depending on your version of Python, these libraries may also be installed:
http://pypi.python.org/pypi/simplejson/

4
TODO
View File

@@ -1,4 +0,0 @@
TODO
====
- Maybe support Python 3.x?

390
describe.py
View File

@@ -1,390 +0,0 @@
#!/usr/bin/python
#
# Copyright 2012 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Create documentation for generate API surfaces.
Command-line tool that creates documentation for all APIs listed in discovery.
The documentation is generated from a combination of the discovery document and
the generated API surface itself.
"""
__author__ = 'jcgregorio@google.com (Joe Gregorio)'
import argparse
import os
import re
import string
import sys
from apiclient.discovery import DISCOVERY_URI
from apiclient.discovery import build
from apiclient.discovery import build_from_document
from oauth2client.anyjson import simplejson
import httplib2
import uritemplate
CSS = """<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
"""
METHOD_TEMPLATE = """<div class="method">
<code class="details" id="$name">$name($params)</code>
<pre>$doc</pre>
</div>
"""
COLLECTION_LINK = """<p class="toc_element">
<code><a href="$href">$name()</a></code>
</p>
<p class="firstline">Returns the $name Resource.</p>
"""
METHOD_LINK = """<p class="toc_element">
<code><a href="#$name">$name($params)</a></code></p>
<p class="firstline">$firstline</p>"""
BASE = 'docs/dyn'
DIRECTORY_URI = 'https://www.googleapis.com/discovery/v1/apis?preferred=true'
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('--discovery_uri_template', default=DISCOVERY_URI,
help='URI Template for discovery.')
parser.add_argument('--discovery_uri', default='',
help=('URI of discovery document. If supplied then only '
'this API will be documented.'))
parser.add_argument('--directory_uri', default=DIRECTORY_URI,
help=('URI of directory document. Unused if --discovery_uri'
' is supplied.'))
parser.add_argument('--dest', default=BASE,
help='Directory name to write documents into.')
def safe_version(version):
"""Create a safe version of the verion string.
Needed so that we can distinguish between versions
and sub-collections in URIs. I.e. we don't want
adsense_v1.1 to refer to the '1' collection in the v1
version of the adsense api.
Args:
version: string, The version string.
Returns:
The string with '.' replaced with '_'.
"""
return version.replace('.', '_')
def unsafe_version(version):
"""Undoes what safe_version() does.
See safe_version() for the details.
Args:
version: string, The safe version string.
Returns:
The string with '_' replaced with '.'.
"""
return version.replace('_', '.')
def method_params(doc):
"""Document the parameters of a method.
Args:
doc: string, The method's docstring.
Returns:
The method signature as a string.
"""
doclines = doc.splitlines()
if 'Args:' in doclines:
begin = doclines.index('Args:')
if 'Returns:' in doclines[begin+1:]:
end = doclines.index('Returns:', begin)
args = doclines[begin+1: end]
else:
args = doclines[begin+1:]
parameters = []
for line in args:
m = re.search('^\s+([a-zA-Z0-9_]+): (.*)', line)
if m is None:
continue
pname = m.group(1)
desc = m.group(2)
if '(required)' not in desc:
pname = pname + '=None'
parameters.append(pname)
parameters = ', '.join(parameters)
else:
parameters = ''
return parameters
def method(name, doc):
"""Documents an individual method.
Args:
name: string, Name of the method.
doc: string, The methods docstring.
"""
params = method_params(doc)
return string.Template(METHOD_TEMPLATE).substitute(
name=name, params=params, doc=doc)
def breadcrumbs(path, root_discovery):
"""Create the breadcrumb trail to this page of documentation.
Args:
path: string, Dot separated name of the resource.
root_discovery: Deserialized discovery document.
Returns:
HTML with links to each of the parent resources of this resource.
"""
parts = path.split('.')
crumbs = []
accumulated = []
for i, p in enumerate(parts):
prefix = '.'.join(accumulated)
# The first time through prefix will be [], so we avoid adding in a
# superfluous '.' to prefix.
if prefix:
prefix += '.'
display = p
if i == 0:
display = root_discovery.get('title', display)
crumbs.append('<a href="%s.html">%s</a>' % (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 = [
'<html><body>',
css,
'<h1>%s</h1>' % breadcrumbs(path[:-1], root_discovery),
'<h2>Instance Methods</h2>'
]
# 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('<h3>Method Details</h3>')
for name in methods:
dname = name.rsplit('_')[0]
html.append(method(name, getattr(resource, name).__doc__))
html.append('</body></html>')
return '\n'.join(html)
def document_collection_recursive(resource, path, root_discovery, discovery):
html = document_collection(resource, path, root_discovery, discovery)
f = open(os.path.join(FLAGS.dest, path + 'html'), 'w')
f.write(html.encode('utf-8'))
f.close()
for name in dir(resource):
if (not name.startswith('_')
and callable(getattr(resource, name))
and hasattr(getattr(resource, name), '__is_resource__')):
dname = name.rsplit('_')[0]
collection = getattr(resource, name)()
document_collection_recursive(collection, path + name + '.', root_discovery,
discovery['resources'].get(dname, {}))
def document_api(name, version):
"""Document the given API.
Args:
name: string, Name of the API.
version: string, Version of the API.
"""
service = build(name, version)
response, content = http.request(
uritemplate.expand(
FLAGS.discovery_uri_template, {
'api': name,
'apiVersion': version})
)
discovery = simplejson.loads(content)
version = safe_version(version)
document_collection_recursive(
service, '%s_%s.' % (name, version), discovery, discovery)
def document_api_from_discovery_document(uri):
"""Document the given API.
Args:
uri: string, URI of discovery document.
"""
http = httplib2.Http()
response, content = http.request(FLAGS.discovery_uri)
discovery = simplejson.loads(content)
service = build_from_document(discovery)
name = discovery['version']
version = safe_version(discovery['version'])
document_collection_recursive(
service, '%s_%s.' % (name, version), discovery, discovery)
if __name__ == '__main__':
FLAGS = parser.parse_args(sys.argv[1:])
if FLAGS.discovery_uri:
document_api_from_discovery_document(FLAGS.discovery_uri)
else:
http = httplib2.Http()
resp, content = http.request(
FLAGS.directory_uri,
headers={'X-User-IP': '0.0.0.0'})
if resp.status == 200:
directory = simplejson.loads(content)['items']
for api in directory:
document_api(api['name'], api['version'])
else:
sys.exit("Failed to load the discovery document.")

5
docs/build.sh → docs/build
View File

@@ -22,7 +22,6 @@
# Notes: You may have to update the location of the
# App Engine library for your local system.
export GOOGLE_APPENGINE=$HOME/projects/google_appengine/
export DJANGO_SETTINGS_MODULE=fakesettings
export PYTHONPATH=`pwd`/..:$GOOGLE_APPENGINE
epydoc --output epy --graph all --parse-only --docformat plaintext apiclient oauth2client
export PYTHONPATH=$(pwd)/..
epydoc --output epy --graph all --parse-only --docformat plaintext oauth2client

258
docs/dyn/adexchangebuyer_v1_1.accounts.html
View File

@@ -1,258 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_1.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_1.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(id)</a></code></p>
<p class="firstline">Gets one account by ID.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
<p class="toc_element">
<code><a href="#patch">patch(id, body)</a></code></p>
<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(id, body)</a></code></p>
<p class="firstline">Updates an existing account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(id)</code>
<pre>Gets one account by ID.
Args:
id: integer, The account id (required)
Returns:
An object of the form:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Retrieves the authenticated user's list of accounts.
Args:
Returns:
An object of the form:
{ # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
"items": [ # A list of accounts.
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
},
],
"kind": "adexchangebuyer#accountsList", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(id, body)</code>
<pre>Updates an existing account. This method supports patch semantics.
Args:
id: integer, The account id (required)
body: object, The request body. (required)
The object takes the form of:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}
Returns:
An object of the form:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(id, body)</code>
<pre>Updates an existing account.
Args:
id: integer, The account id (required)
body: object, The request body. (required)
The object takes the form of:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}
Returns:
An object of the form:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}</pre>
</div>
</body></html>

284
docs/dyn/adexchangebuyer_v1_1.creatives.html
View File

@@ -1,284 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_1.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_1.creatives.html">creatives</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, buyerCreativeId)</a></code></p>
<p class="firstline">Gets the status for a single creative.</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Submit a new creative.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None, statusFilter=None)</a></code></p>
<p class="firstline">Retrieves a list of the authenticated user's active creatives.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, buyerCreativeId)</code>
<pre>Gets the status for a single creative.
Args:
accountId: integer, The id for the account that will serve this creative. (required)
buyerCreativeId: string, The buyer-specific id for this creative. (required)
Returns:
An object of the form:
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
"A String",
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>Submit a new creative.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
"A String",
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
}
Returns:
An object of the form:
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
"A String",
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None, statusFilter=None)</code>
<pre>Retrieves a list of the authenticated user's active creatives.
Args:
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
statusFilter: string, When specified, only creatives having the given status are returned.
Allowed values
approved - Creatives which have been approved.
disapproved - Creatives which have been disapproved.
not_checked - Creatives whose status is not yet checked.
Returns:
An object of the form:
{ # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
"nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # A list of creatives.
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
"A String",
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
},
],
"kind": "adexchangebuyer#creativesList", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

134
docs/dyn/adexchangebuyer_v1_1.directDeals.html
View File

@@ -1,134 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_1.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_1.directDeals.html">directDeals</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(id)</a></code></p>
<p class="firstline">Gets one direct deal by ID.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves the authenticated user's list of direct deals.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(id)</code>
<pre>Gets one direct deal by ID.
Args:
id: string, The direct deal id (required)
Returns:
An object of the form:
{ # The configuration data for an Ad Exchange direct deal.
"advertiser": "A String", # The name of the advertiser this deal is for.
"kind": "adexchangebuyer#directDeal", # Resource type.
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
"startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
"endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.
"id": "A String", # Deal id.
"accountId": 42, # The account id of the buyer this deal is for.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Retrieves the authenticated user's list of direct deals.
Args:
Returns:
An object of the form:
{ # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
"kind": "adexchangebuyer#directDealsList", # Resource type.
"directDeals": [ # A list of direct deals relevant for your account.
{ # The configuration data for an Ad Exchange direct deal.
"advertiser": "A String", # The name of the advertiser this deal is for.
"kind": "adexchangebuyer#directDeal", # Resource type.
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
"startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
"endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.
"id": "A String", # Deal id.
"accountId": 42, # The account id of the buyer this deal is for.
},
],
}</pre>
</div>
</body></html>

92
docs/dyn/adexchangebuyer_v1_1.html
View File

@@ -1,92 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_1.html">Ad Exchange Buyer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_1.accounts.html">accounts()</a></code>
</p>
<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_1.creatives.html">creatives()</a></code>
</p>
<p class="firstline">Returns the creatives Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_1.directDeals.html">directDeals()</a></code>
</p>
<p class="firstline">Returns the directDeals Resource.</p>
</body></html>

258
docs/dyn/adexchangebuyer_v1_2.accounts.html
View File

@@ -1,258 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(id)</a></code></p>
<p class="firstline">Gets one account by ID.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves the authenticated user's list of accounts.</p>
<p class="toc_element">
<code><a href="#patch">patch(id, body)</a></code></p>
<p class="firstline">Updates an existing account. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(id, body)</a></code></p>
<p class="firstline">Updates an existing account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(id)</code>
<pre>Gets one account by ID.
Args:
id: integer, The account id (required)
Returns:
An object of the form:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Retrieves the authenticated user's list of accounts.
Args:
Returns:
An object of the form:
{ # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
"items": [ # A list of accounts.
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
},
],
"kind": "adexchangebuyer#accountsList", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(id, body)</code>
<pre>Updates an existing account. This method supports patch semantics.
Args:
id: integer, The account id (required)
body: object, The request body. (required)
The object takes the form of:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}
Returns:
An object of the form:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(id, body)</code>
<pre>Updates an existing account.
Args:
id: integer, The account id (required)
body: object, The request body. (required)
The object takes the form of:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}
Returns:
An object of the form:
{ # Configuration data for an Ad Exchange buyer account.
"kind": "adexchangebuyer#account", # Resource type.
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
"bidderLocation": [ # Your bidder locations that have distinct URLs.
{
"url": "A String", # The URL to which the Ad Exchange will send bid requests.
"region": "A String", # The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values:
# - ASIA
# - EUROPE
# - US_EAST
# - US_WEST
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
},
],
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
"id": 42, # Account id.
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
}</pre>
</div>
</body></html>

308
docs/dyn/adexchangebuyer_v1_2.creatives.html
View File

@@ -1,308 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.creatives.html">creatives</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, buyerCreativeId)</a></code></p>
<p class="firstline">Gets the status for a single creative.</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Submit a new creative.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None, statusFilter=None)</a></code></p>
<p class="firstline">Retrieves a list of the authenticated user's active creatives.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, buyerCreativeId)</code>
<pre>Gets the status for a single creative.
Args:
accountId: integer, The id for the account that will serve this creative. (required)
buyerCreativeId: string, The buyer-specific id for this creative. (required)
Returns:
An object of the form:
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"agencyId": "A String", # The agency id for this creative.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"reason": "A String", # The categorized reason for disapproval.
"details": [ # Additional details about the reason for disapproval.
"A String",
],
},
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>Submit a new creative.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"agencyId": "A String", # The agency id for this creative.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"reason": "A String", # The categorized reason for disapproval.
"details": [ # Additional details about the reason for disapproval.
"A String",
],
},
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
}
Returns:
An object of the form:
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"agencyId": "A String", # The agency id for this creative.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"reason": "A String", # The categorized reason for disapproval.
"details": [ # Additional details about the reason for disapproval.
"A String",
],
},
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None, statusFilter=None)</code>
<pre>Retrieves a list of the authenticated user's active creatives.
Args:
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
statusFilter: string, When specified, only creatives having the given status are returned.
Allowed values
approved - Creatives which have been approved.
disapproved - Creatives which have been disapproved.
not_checked - Creatives whose status is not yet checked.
Returns:
An object of the form:
{ # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
"nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # A list of creatives.
{ # A creative and its classification data.
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
42,
],
"advertiserName": "A String", # The name of the company being advertised in the creative.
"kind": "adexchangebuyer#creative", # Resource type.
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
"agencyId": "A String", # The agency id for this creative.
"width": 42, # Ad width.
"attribute": [ # All attributes for the ads that may be shown from this snippet.
42,
],
"height": 42, # Ad height.
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
42,
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"reason": "A String", # The categorized reason for disapproval.
"details": [ # Additional details about the reason for disapproval.
"A String",
],
},
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"accountId": 42, # Account id.
},
],
"kind": "adexchangebuyer#creativesList", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

136
docs/dyn/adexchangebuyer_v1_2.directDeals.html
View File

@@ -1,136 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.directDeals.html">directDeals</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(id)</a></code></p>
<p class="firstline">Gets one direct deal by ID.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves the authenticated user's list of direct deals.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(id)</code>
<pre>Gets one direct deal by ID.
Args:
id: string, The direct deal id (required)
Returns:
An object of the form:
{ # The configuration data for an Ad Exchange direct deal.
"advertiser": "A String", # The name of the advertiser this deal is for.
"kind": "adexchangebuyer#directDeal", # Resource type.
"privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
"startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
"endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.
"id": "A String", # Deal id.
"accountId": 42, # The account id of the buyer this deal is for.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Retrieves the authenticated user's list of direct deals.
Args:
Returns:
An object of the form:
{ # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
"kind": "adexchangebuyer#directDealsList", # Resource type.
"directDeals": [ # A list of direct deals relevant for your account.
{ # The configuration data for an Ad Exchange direct deal.
"advertiser": "A String", # The name of the advertiser this deal is for.
"kind": "adexchangebuyer#directDeal", # Resource type.
"privateExchangeMinCpm": "A String", # The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
"startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
"endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.
"id": "A String", # Deal id.
"accountId": 42, # The account id of the buyer this deal is for.
},
],
}</pre>
</div>
</body></html>

97
docs/dyn/adexchangebuyer_v1_2.html
View File

@@ -1,97 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_2.accounts.html">accounts()</a></code>
</p>
<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_2.creatives.html">creatives()</a></code>
</p>
<p class="firstline">Returns the creatives Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_2.directDeals.html">directDeals()</a></code>
</p>
<p class="firstline">Returns the directDeals Resource.</p>
<p class="toc_element">
<code><a href="adexchangebuyer_v1_2.performanceReport.html">performanceReport()</a></code>
</p>
<p class="firstline">Returns the performanceReport Resource.</p>
</body></html>

108
docs/dyn/adexchangebuyer_v1_2.performanceReport.html
View File

@@ -1,108 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangebuyer_v1_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.performanceReport.html">performanceReport</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, endDateTime, startDateTime)</a></code></p>
<p class="firstline">Retrieves the authenticated user's list of performance metrics.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, endDateTime, startDateTime)</code>
<pre>Retrieves the authenticated user's list of performance metrics.
Args:
accountId: string, The account id to get the reports for. (required)
endDateTime: string, The end time for the reports. (required)
startDateTime: string, The start time for the reports. (required)
Returns:
An object of the form:
{ # The configuration data for an Ad Exchange performance report list. TODO(nathanbullock): need to add some release tests before releasing this. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py
"kind": "adexchangebuyer#performanceReportList", # Resource type.
"performance_report": [ # A list of performance reports relevant for the account.
{
"kind": "adexchangebuyer#performanceReport", # Resource type.
"timestamp": "A String", # Timestamp of the starting time of this performance data.
"region": "A String", # The trading location of this data.
"latency50thPercentile": 3.14, # The Nth percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.
"latency85thPercentile": 3.14,
"latency95thPercentile": 3.14,
},
],
}</pre>
</div>
</body></html>

125
docs/dyn/adexchangeseller_v1.adclients.html
View File

@@ -1,125 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad clients in this Ad Exchange account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

132
docs/dyn/adexchangeseller_v1.adunits.customchannels.html
View File

@@ -1,132 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.adunits.html">adunits</a> . <a href="adexchangeseller_v1.adunits.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

165
docs/dyn/adexchangeseller_v1.adunits.html
View File

@@ -1,165 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangeseller_v1.adunits.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, adUnitId)</a></code></p>
<p class="firstline">Gets the specified ad unit in the specified ad client.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified ad client for this Ad Exchange account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId, adUnitId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

133
docs/dyn/adexchangeseller_v1.customchannels.adunits.html
View File

@@ -1,133 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.customchannels.html">customchannels</a> . <a href="adexchangeseller_v1.customchannels.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified custom channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

164
docs/dyn/adexchangeseller_v1.customchannels.html
View File

@@ -1,164 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangeseller_v1.customchannels.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, customChannelId)</a></code></p>
<p class="firstline">Get the specified custom channel from the specified ad client.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels in the specified ad client for this Ad Exchange account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId, customChannelId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

102
docs/dyn/adexchangeseller_v1.html
View File

@@ -1,102 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangeseller_v1.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adexchangeseller_v1.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="adexchangeseller_v1.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="adexchangeseller_v1.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="adexchangeseller_v1.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
</body></html>

155
docs/dyn/adexchangeseller_v1.reports.html
View File

@@ -1,155 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adexchangeseller_v1.reports.saved.html">saved()</a></code>
</p>
<p class="firstline">Returns the saved Resource.</p>
<p class="toc_element">
<code><a href="#generate">generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#generate_media">generate_media(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="generate_media">generate_media(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code>
<pre>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.
</pre>
</div>
</body></html>

166
docs/dyn/adexchangeseller_v1.reports.saved.html
View File

@@ -1,166 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.reports.html">reports</a> . <a href="adexchangeseller_v1.reports.saved.html">saved</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Generate an Ad Exchange report based on the saved report ID sent in the query parameters.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved reports in this Ad Exchange account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

124
docs/dyn/adexchangeseller_v1.urlchannels.html
View File

@@ -1,124 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adexchangeseller_v1.html">Ad Exchange Seller API</a> . <a href="adexchangeseller_v1.urlchannels.html">urlchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all URL channels in the specified ad client for this Ad Exchange account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

155
docs/dyn/admin_reports_v1.activities.html
View File

@@ -1,155 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.activities.html">activities</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)</a></code></p>
<p class="firstline">Retrieves a list of activities for a specific customer and application.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(userKey, applicationName, eventName=None, actorIpAddress=None, filters=None, maxResults=None, pageToken=None, startTime=None, endTime=None)</code>
<pre>Retrieves a list of activities for a specific customer and application.
Args:
userKey: string, Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users. (required)
applicationName: string, Application name for which the events are to be retrieved. (required)
eventName: string, Name of the event being queried.
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
maxResults: integer, Number of activity records to be shown in each page.
pageToken: string, Token to specify next page.
startTime: string, Return events which occured at or after this time.
endTime: string, Return events which occured at or before this time.
Returns:
An object of the form:
{ # JSON template for a collection of activites.
"nextPageToken": "A String", # Token for retrieving the next page
"items": [ # Each record in read response.
{ # JSON template for the activity resource.
"kind": "admin#reports#activity", # Kind of resource this is.
"ownerDomain": "A String", # Domain of source customer.
"actor": { # User doing the action.
"profileId": "A String", # Obfuscated user id of the user.
"email": "A String", # Email address of the user.
"key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
"callerType": "A String", # User or OAuth 2LO request.
},
"id": { # Unique identifier for each activity record.
"applicationName": "A String", # Application name to which the event belongs.
"uniqueQualifier": "A String", # Unique qualifier if multiple events have the same time.
"customerId": "A String", # Obfuscated customer ID of the source customer.
"time": "A String", # Time of occurrence of the activity.
},
"ipAddress": "A String", # IP Address of the user doing the action.
"events": [ # Activity events.
{
"type": "A String", # Type of event.
"name": "A String", # Name of event.
"parameters": [ # Parameter value pairs for various applications.
{
"boolValue": True or False, # Boolean value of the parameter.
"intValue": "A String", # Integral value of the parameter.
"value": "A String", # String value of the parameter.
"name": "A String", # The name of the parameter.
},
],
},
],
},
],
"kind": "admin#reports#activities", # Kind of list response this is.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

149
docs/dyn/admin_reports_v1.customerUsageReports.html
View File

@@ -1,149 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.customerUsageReports.html">customerUsageReports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(date, pageToken=None, parameters=None)</a></code></p>
<p class="firstline">Retrieves a report which is a collection of properties / statistics for a specific customer.</p>
<p class="toc_element">
<code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(date, pageToken=None, parameters=None)</code>
<pre>Retrieves a report which is a collection of properties / statistics for a specific customer.
Args:
date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
pageToken: string, Token to specify next page.
parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
Returns:
An object of the form:
{ # JSON template for a collection of usage reports.
"nextPageToken": "A String", # Token for retrieving the next page
"kind": "admin#reports#usageReports", # The kind of object.
"usageReports": [ # Various application parameter records.
{ # JSON template for a usage report.
"date": "A String", # The date to which the record belongs.
"kind": "admin#reports#usageReport", # The kind of object.
"parameters": [ # Parameter value pairs for various applications.
{
"stringValue": "A String", # String value of the parameter.
"boolValue": True or False, # Boolean value of the parameter.
"datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
"intValue": "A String", # Integral value of the parameter.
"name": "A String", # The name of the parameter.
},
],
"entity": { # Information about the type of the item.
"profileId": "A String", # Obfuscated user id for the record.
"userEmail": "A String", # user's email.
"type": "A String", # The type of item, can be a customer or user.
"customerId": "A String", # Obfuscated customer id for the record.
},
},
],
"warnings": [ # Warnings if any.
{
"message": "A String", # Human readable message for the warning.
"code": "A String", # Machine readable code / warning type.
"data": [ # Key-Value pairs to give detailed information on the warning.
{
"value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
"key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="get_next">get_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

92
docs/dyn/admin_reports_v1.html
View File

@@ -1,92 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_reports_v1.html">Admin Reports API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="admin_reports_v1.activities.html">activities()</a></code>
</p>
<p class="firstline">Returns the activities Resource.</p>
<p class="toc_element">
<code><a href="admin_reports_v1.customerUsageReports.html">customerUsageReports()</a></code>
</p>
<p class="firstline">Returns the customerUsageReports Resource.</p>
<p class="toc_element">
<code><a href="admin_reports_v1.userUsageReport.html">userUsageReport()</a></code>
</p>
<p class="firstline">Returns the userUsageReport Resource.</p>
</body></html>

152
docs/dyn/admin_reports_v1.userUsageReport.html
View File

@@ -1,152 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.userUsageReport.html">userUsageReport</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a report which is a collection of properties / statistics for a set of users.</p>
<p class="toc_element">
<code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(userKey, date, parameters=None, pageToken=None, filters=None, maxResults=None)</code>
<pre>Retrieves a report which is a collection of properties / statistics for a set of users.
Args:
userKey: string, Represents the profile id or the user email for which the data should be filtered. (required)
date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
pageToken: string, Token to specify next page.
filters: string, Represents the set of filters including parameter operator value.
maxResults: integer, Maximum number of results to return. Maximum allowed is 1000
Returns:
An object of the form:
{ # JSON template for a collection of usage reports.
"nextPageToken": "A String", # Token for retrieving the next page
"kind": "admin#reports#usageReports", # The kind of object.
"usageReports": [ # Various application parameter records.
{ # JSON template for a usage report.
"date": "A String", # The date to which the record belongs.
"kind": "admin#reports#usageReport", # The kind of object.
"parameters": [ # Parameter value pairs for various applications.
{
"stringValue": "A String", # String value of the parameter.
"boolValue": True or False, # Boolean value of the parameter.
"datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
"intValue": "A String", # Integral value of the parameter.
"name": "A String", # The name of the parameter.
},
],
"entity": { # Information about the type of the item.
"profileId": "A String", # Obfuscated user id for the record.
"userEmail": "A String", # user's email.
"type": "A String", # The type of item, can be a customer or user.
"customerId": "A String", # Obfuscated customer id for the record.
},
},
],
"warnings": [ # Warnings if any.
{
"message": "A String", # Human readable message for the warning.
"code": "A String", # Machine readable code / warning type.
"data": [ # Key-Value pairs to give detailed information on the warning.
{
"value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
"key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
},
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="get_next">get_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

126
docs/dyn/adsense_v1_2.accounts.adclients.html
View File

@@ -1,126 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad clients in the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

133
docs/dyn/adsense_v1_2.accounts.adunits.customchannels.html
View File

@@ -1,133 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.adunits.html">adunits</a> . <a href="adsense_v1_2.accounts.adunits.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels which the specified ad unit belongs to.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client which contains the ad unit. (required)
adUnitId: string, Ad unit for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

241
docs/dyn/adsense_v1_2.accounts.adunits.html
View File

@@ -1,241 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.adunits.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Gets the specified ad unit in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, adClientId, adUnitId)</code>
<pre>Gets the specified ad unit in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to get the ad unit. (required)
adUnitId: string, Ad unit to retrieve. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

171
docs/dyn/adsense_v1_2.accounts.customchannels.adunits.html
View File

@@ -1,171 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.customchannels.html">customchannels</a> . <a href="adsense_v1_2.accounts.customchannels.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified custom channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified custom channel.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

166
docs/dyn/adsense_v1_2.accounts.customchannels.html
View File

@@ -1,166 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.customchannels.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId, customChannelId)</a></code></p>
<p class="firstline">Get the specified custom channel from the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, adClientId, customChannelId)</code>
<pre>Get the specified custom channel from the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel to retrieve. (required)
Returns:
An object of the form:
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

182
docs/dyn/adsense_v1_2.accounts.html
View File

@@ -1,182 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.savedadstyles.html">savedadstyles()</a></code>
</p>
<p class="firstline">Returns the savedadstyles Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, tree=None)</a></code></p>
<p class="firstline">Get information about the selected AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all accounts available to this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, tree=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

159
docs/dyn/adsense_v1_2.accounts.reports.html
View File

@@ -1,159 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.reports.saved.html">saved()</a></code>
</p>
<p class="firstline">Returns the saved Resource.</p>
<p class="toc_element">
<code><a href="#generate">generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#generate_media">generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
Args:
accountId: string, Account upon which to report. (required)
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
metric: string, Numeric columns to include in the report. (repeated)
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
startIndex: integer, Index of the first row of report data to return.
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
maxResults: integer, The maximum number of rows of report data to return.
filter: string, Filters to be run on the report. (repeated)
dimension: string, Dimensions to base the report on. (repeated)
Returns:
An object of the form:
{
"kind": "adsense#report", # Kind this is, in this case adsense#report.
"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
[
"A String",
],
],
"warnings": [ # Any warnings associated with generation of the report.
"A String",
],
"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
"A String",
],
"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
{
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
"name": "A String", # The name of the header.
},
],
"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="generate_media">generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
Args:
accountId: string, Account upon which to report. (required)
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
metric: string, Numeric columns to include in the report. (repeated)
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
startIndex: integer, Index of the first row of report data to return.
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
maxResults: integer, The maximum number of rows of report data to return.
filter: string, Filters to be run on the report. (repeated)
dimension: string, Dimensions to base the report on. (repeated)
Returns:
The media object as a string.
</pre>
</div>
</body></html>

168
docs/dyn/adsense_v1_2.accounts.reports.saved.html
View File

@@ -1,168 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.reports.html">reports</a> . <a href="adsense_v1_2.accounts.reports.saved.html">saved</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Generate an AdSense report based on the saved report ID sent in the query parameters.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved reports in the specified AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

175
docs/dyn/adsense_v1_2.accounts.savedadstyles.html
View File

@@ -1,175 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.savedadstyles.html">savedadstyles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, savedAdStyleId)</a></code></p>
<p class="firstline">List a specific saved ad style for the specified account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved ad styles in the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, savedAdStyleId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

125
docs/dyn/adsense_v1_2.accounts.urlchannels.html
View File

@@ -1,125 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.accounts.html">accounts</a> . <a href="adsense_v1_2.accounts.urlchannels.html">urlchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all URL channels in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

125
docs/dyn/adsense_v1_2.adclients.html
View File

@@ -1,125 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad clients in this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

132
docs/dyn/adsense_v1_2.adunits.customchannels.html
View File

@@ -1,132 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.adunits.html">adunits</a> . <a href="adsense_v1_2.adunits.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels which the specified ad unit belongs to.
Args:
adClientId: string, Ad client which contains the ad unit. (required)
adUnitId: string, Ad unit for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

239
docs/dyn/adsense_v1_2.adunits.html
View File

@@ -1,239 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.adunits.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, adUnitId)</a></code></p>
<p class="firstline">Gets the specified ad unit in the specified ad client.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified ad client for this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId, adUnitId)</code>
<pre>Gets the specified ad unit in the specified ad client.
Args:
adClientId: string, Ad client for which to get the ad unit. (required)
adUnitId: string, Ad unit to retrieve. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified ad client for this AdSense account.
Args:
adClientId: string, Ad client for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

170
docs/dyn/adsense_v1_2.customchannels.adunits.html
View File

@@ -1,170 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.customchannels.html">customchannels</a> . <a href="adsense_v1_2.customchannels.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified custom channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified custom channel.
Args:
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

164
docs/dyn/adsense_v1_2.customchannels.html
View File

@@ -1,164 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.customchannels.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, customChannelId)</a></code></p>
<p class="firstline">Get the specified custom channel from the specified ad client.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels in the specified ad client for this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId, customChannelId)</code>
<pre>Get the specified custom channel from the specified ad client.
Args:
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel to retrieve. (required)
Returns:
An object of the form:
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels in the specified ad client for this AdSense account.
Args:
adClientId: string, Ad client for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

112
docs/dyn/adsense_v1_2.html
View File

@@ -1,112 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.accounts.html">accounts()</a></code>
</p>
<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.savedadstyles.html">savedadstyles()</a></code>
</p>
<p class="firstline">Returns the savedadstyles Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_2.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
</body></html>

159
docs/dyn/adsense_v1_2.reports.html
View File

@@ -1,159 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_2.reports.saved.html">saved()</a></code>
</p>
<p class="firstline">Returns the saved Resource.</p>
<p class="toc_element">
<code><a href="#generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
Args:
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
metric: string, Numeric columns to include in the report. (repeated)
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
startIndex: integer, Index of the first row of report data to return.
accountId: string, Accounts upon which to report. (repeated)
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
maxResults: integer, The maximum number of rows of report data to return.
filter: string, Filters to be run on the report. (repeated)
dimension: string, Dimensions to base the report on. (repeated)
Returns:
An object of the form:
{
"kind": "adsense#report", # Kind this is, in this case adsense#report.
"rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
[
"A String",
],
],
"warnings": [ # Any warnings associated with generation of the report.
"A String",
],
"totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
"A String",
],
"headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
{
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
"name": "A String", # The name of the header.
},
],
"totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
"averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
Args:
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
metric: string, Numeric columns to include in the report. (repeated)
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
startIndex: integer, Index of the first row of report data to return.
accountId: string, Accounts upon which to report. (repeated)
sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
maxResults: integer, The maximum number of rows of report data to return.
filter: string, Filters to be run on the report. (repeated)
dimension: string, Dimensions to base the report on. (repeated)
Returns:
The media object as a string.
</pre>
</div>
</body></html>

166
docs/dyn/adsense_v1_2.reports.saved.html
View File

@@ -1,166 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.reports.html">reports</a> . <a href="adsense_v1_2.reports.saved.html">saved</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Generate an AdSense report based on the saved report ID sent in the query parameters.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved reports in this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

173
docs/dyn/adsense_v1_2.savedadstyles.html
View File

@@ -1,173 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.savedadstyles.html">savedadstyles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(savedAdStyleId)</a></code></p>
<p class="firstline">Get a specific saved ad style from the user's account.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved ad styles in the user's account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(savedAdStyleId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

124
docs/dyn/adsense_v1_2.urlchannels.html
View File

@@ -1,124 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_2.html">AdSense Management API</a> . <a href="adsense_v1_2.urlchannels.html">urlchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all URL channels in the specified ad client for this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

126
docs/dyn/adsense_v1_3.accounts.adclients.html
View File

@@ -1,126 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad clients in the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

133
docs/dyn/adsense_v1_3.accounts.adunits.customchannels.html
View File

@@ -1,133 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.adunits.html">adunits</a> . <a href="adsense_v1_3.accounts.adunits.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels which the specified ad unit belongs to.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client which contains the ad unit. (required)
adUnitId: string, Ad unit for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

262
docs/dyn/adsense_v1_3.accounts.adunits.html
View File

@@ -1,262 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.adunits.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Gets the specified ad unit in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Get ad code for the specified ad unit.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, adClientId, adUnitId)</code>
<pre>Gets the specified ad unit in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to get the ad unit. (required)
adUnitId: string, Ad unit to retrieve. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="getAdCode">getAdCode(accountId, adClientId, adUnitId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

106
docs/dyn/adsense_v1_3.accounts.alerts.html
View File

@@ -1,106 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.alerts.html">alerts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, locale=None)</a></code></p>
<p class="firstline">List the alerts for the specified AdSense account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, locale=None)</code>
<pre>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.
}</pre>
</div>
</body></html>

171
docs/dyn/adsense_v1_3.accounts.customchannels.adunits.html
View File

@@ -1,171 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.customchannels.html">customchannels</a> . <a href="adsense_v1_3.accounts.customchannels.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified custom channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified custom channel.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

166
docs/dyn/adsense_v1_3.accounts.customchannels.html
View File

@@ -1,166 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.customchannels.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId, customChannelId)</a></code></p>
<p class="firstline">Get the specified custom channel from the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, adClientId, customChannelId)</code>
<pre>Get the specified custom channel from the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel to retrieve. (required)
Returns:
An object of the form:
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels in the specified ad client for the specified account.
Args:
accountId: string, Account to which the ad client belongs. (required)
adClientId: string, Ad client for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

187
docs/dyn/adsense_v1_3.accounts.html
View File

@@ -1,187 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.alerts.html">alerts()</a></code>
</p>
<p class="firstline">Returns the alerts Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.savedadstyles.html">savedadstyles()</a></code>
</p>
<p class="firstline">Returns the savedadstyles Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, tree=None)</a></code></p>
<p class="firstline">Get information about the selected AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all accounts available to this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, tree=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

161
docs/dyn/adsense_v1_3.accounts.reports.html
View File

@@ -1,161 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.reports.saved.html">saved()</a></code>
</p>
<p class="firstline">Returns the saved Resource.</p>
<p class="toc_element">
<code><a href="#generate">generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#generate_media">generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="generate_media">generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>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.
</pre>
</div>
</body></html>

168
docs/dyn/adsense_v1_3.accounts.reports.saved.html
View File

@@ -1,168 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.reports.html">reports</a> . <a href="adsense_v1_3.accounts.reports.saved.html">saved</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Generate an AdSense report based on the saved report ID sent in the query parameters.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved reports in the specified AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(accountId, savedReportId, locale=None, maxResults=None, startIndex=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

175
docs/dyn/adsense_v1_3.accounts.savedadstyles.html
View File

@@ -1,175 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.savedadstyles.html">savedadstyles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, savedAdStyleId)</a></code></p>
<p class="firstline">List a specific saved ad style for the specified account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved ad styles in the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, savedAdStyleId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

125
docs/dyn/adsense_v1_3.accounts.urlchannels.html
View File

@@ -1,125 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.accounts.html">accounts</a> . <a href="adsense_v1_3.accounts.urlchannels.html">urlchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all URL channels in the specified ad client for the specified account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

125
docs/dyn/adsense_v1_3.adclients.html
View File

@@ -1,125 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad clients in this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

132
docs/dyn/adsense_v1_3.adunits.customchannels.html
View File

@@ -1,132 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.adunits.html">adunits</a> . <a href="adsense_v1_3.adunits.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels which the specified ad unit belongs to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, adUnitId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels which the specified ad unit belongs to.
Args:
adClientId: string, Ad client which contains the ad unit. (required)
adUnitId: string, Ad unit for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

259
docs/dyn/adsense_v1_3.adunits.html
View File

@@ -1,259 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.adunits.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, adUnitId)</a></code></p>
<p class="firstline">Gets the specified ad unit in the specified ad client.</p>
<p class="toc_element">
<code><a href="#getAdCode">getAdCode(adClientId, adUnitId)</a></code></p>
<p class="firstline">Get ad code for the specified ad unit.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified ad client for this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId, adUnitId)</code>
<pre>Gets the specified ad unit in the specified ad client.
Args:
adClientId: string, Ad client for which to get the ad unit. (required)
adUnitId: string, Ad unit to retrieve. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="getAdCode">getAdCode(adClientId, adUnitId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified ad client for this AdSense account.
Args:
adClientId: string, Ad client for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

105
docs/dyn/adsense_v1_3.alerts.html
View File

@@ -1,105 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.alerts.html">alerts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(locale=None)</a></code></p>
<p class="firstline">List the alerts for this AdSense account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(locale=None)</code>
<pre>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.
}</pre>
</div>
</body></html>

170
docs/dyn/adsense_v1_3.customchannels.adunits.html
View File

@@ -1,170 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.customchannels.html">customchannels</a> . <a href="adsense_v1_3.customchannels.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified custom channel.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified custom channel.
Args:
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"feedAdsSettings": { # Settings specific to feed ads (AFF).
"minimumWordCount": 42, # The minimum length an entry should be in order to have attached ads.
"frequency": 42, # The frequency at which ads should appear in the feed (i.e. every N entries).
"adPosition": "A String", # The position of the ads relative to the feed entries.
"type": "A String", # The type of ads which should appear.
},
"savedStyleId": "A String", # ID of the saved ad style which holds this ad unit's style information.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad.
"colors": { # The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font.
"size": "A String", # The size of the font.
},
"kind": "adsense#adStyle", # Kind this is, in this case adsense#adStyle.
},
},
],
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

164
docs/dyn/adsense_v1_3.customchannels.html
View File

@@ -1,164 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.customchannels.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, customChannelId)</a></code></p>
<p class="firstline">Get the specified custom channel from the specified ad client.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all custom channels in the specified ad client for this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId, customChannelId)</code>
<pre>Get the specified custom channel from the specified ad client.
Args:
adClientId: string, Ad client which contains the custom channel. (required)
customChannelId: string, Custom channel to retrieve. (required)
Returns:
An object of the form:
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>List all custom channels in the specified ad client for this AdSense account.
Args:
adClientId: string, Ad client for which to list custom channels. (required)
pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The custom channels returned in this list response.
{
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
"targetingInfo": { # The targeting information of this custom channel, if activated.
"location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
"adsAppearOn": "A String", # The name used to describe this channel externally.
"siteLanguage": "A String", # The language of the sites ads will be displayed on.
"description": "A String", # The external description of the channel.
},
"id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"name": "A String", # Name of this custom channel.
},
],
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

122
docs/dyn/adsense_v1_3.html
View File

@@ -1,122 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.accounts.html">accounts()</a></code>
</p>
<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.alerts.html">alerts()</a></code>
</p>
<p class="firstline">Returns the alerts Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.metadata.html">metadata()</a></code>
</p>
<p class="firstline">Returns the metadata Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.savedadstyles.html">savedadstyles()</a></code>
</p>
<p class="firstline">Returns the savedadstyles Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
</body></html>

116
docs/dyn/adsense_v1_3.metadata.dimensions.html
View File

@@ -1,116 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.metadata.html">metadata</a> . <a href="adsense_v1_3.metadata.dimensions.html">dimensions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">List the metadata for the dimensions available to this AdSense account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list()</code>
<pre>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.
}</pre>
</div>
</body></html>

87
docs/dyn/adsense_v1_3.metadata.html
View File

@@ -1,87 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.metadata.html">metadata</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.metadata.dimensions.html">dimensions()</a></code>
</p>
<p class="firstline">Returns the dimensions Resource.</p>
<p class="toc_element">
<code><a href="adsense_v1_3.metadata.metrics.html">metrics()</a></code>
</p>
<p class="firstline">Returns the metrics Resource.</p>
</body></html>

116
docs/dyn/adsense_v1_3.metadata.metrics.html
View File

@@ -1,116 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.metadata.html">metadata</a> . <a href="adsense_v1_3.metadata.metrics.html">metrics</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">List the metadata for the metrics available to this AdSense account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list()</code>
<pre>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.
}</pre>
</div>
</body></html>

161
docs/dyn/adsense_v1_3.reports.html
View File

@@ -1,161 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsense_v1_3.reports.saved.html">saved()</a></code>
</p>
<p class="firstline">Returns the saved Resource.</p>
<p class="toc_element">
<code><a href="#generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="generate_media">generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, useTimezoneReporting=None, sort=None, maxResults=None, filter=None, dimension=None)</code>
<pre>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.
</pre>
</div>
</body></html>

166
docs/dyn/adsense_v1_3.reports.saved.html
View File

@@ -1,166 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.reports.html">reports</a> . <a href="adsense_v1_3.reports.saved.html">saved</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Generate an AdSense report based on the saved report ID sent in the query parameters.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved reports in this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(savedReportId, locale=None, maxResults=None, startIndex=None)</code>
<pre>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",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

173
docs/dyn/adsense_v1_3.savedadstyles.html
View File

@@ -1,173 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.savedadstyles.html">savedadstyles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(savedAdStyleId)</a></code></p>
<p class="firstline">Get a specific saved ad style from the user's account.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all saved ad styles in the user's account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(savedAdStyleId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

124
docs/dyn/adsense_v1_3.urlchannels.html
View File

@@ -1,124 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsense_v1_3.html">AdSense Management API</a> . <a href="adsense_v1_3.urlchannels.html">urlchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all URL channels in the specified ad client for this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

149
docs/dyn/adsensehost_v4_1.accounts.adclients.html
View File

@@ -1,149 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a> . <a href="adsensehost_v4_1.accounts.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId)</a></code></p>
<p class="firstline">Get information about one of the ad clients in the specified publisher's AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all hosted ad clients in the specified hosted account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, adClientId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

616
docs/dyn/adsensehost_v4_1.accounts.adunits.html
View File

@@ -1,616 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a> . <a href="adsensehost_v4_1.accounts.adunits.html">adunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Delete the specified ad unit from the specified publisher AdSense account.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, adClientId, adUnitId)</a></code></p>
<p class="firstline">Get the specified host ad unit in this AdSense account.</p>
<p class="toc_element">
<code><a href="#getAdCode">getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)</a></code></p>
<p class="firstline">Get ad code for the specified ad unit, attaching the specified host custom channels.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, adClientId, body)</a></code></p>
<p class="firstline">Insert the supplied ad unit into the specified publisher AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</a></code></p>
<p class="firstline">List all ad units in the specified publisher's AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, adClientId, adUnitId, body)</a></code></p>
<p class="firstline">Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, adClientId, body)</a></code></p>
<p class="firstline">Update the supplied ad unit in the specified publisher AdSense account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(accountId, adClientId, adUnitId)</code>
<pre>Delete the specified ad unit from the specified publisher AdSense account.
Args:
accountId: string, Account which contains the ad unit. (required)
adClientId: string, Ad client for which to get ad unit. (required)
adUnitId: string, Ad unit to delete. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, adClientId, adUnitId)</code>
<pre>Get the specified host ad unit in this AdSense account.
Args:
accountId: string, Account which contains the ad unit. (required)
adClientId: string, Ad client for which to get ad unit. (required)
adUnitId: string, Ad unit to get. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="getAdCode">getAdCode(accountId, adClientId, adUnitId, hostCustomChannelId=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, adClientId, body)</code>
<pre>Insert the supplied ad unit into the specified publisher AdSense account.
Args:
accountId: string, Account which will contain the ad unit. (required)
adClientId: string, Ad client into which to insert the ad unit. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)</code>
<pre>List all ad units in the specified publisher's AdSense account.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client for which to list ad units. (required)
pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
includeInactive: boolean, Whether to include inactive ad units. Default: true.
maxResults: integer, The maximum number of ad units to include in the response, used for paging.
Returns:
An object of the form:
{
"nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
"items": [ # The ad units returned in this list response.
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
},
],
"kind": "adsensehost#adUnits", # Kind of list this is, in this case adsensehost#adUnits.
"etag": "A String", # ETag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, adClientId, adUnitId, body)</code>
<pre>Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client which contains the ad unit. (required)
adUnitId: string, Ad unit to get. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, adClientId, body)</code>
<pre>Update the supplied ad unit in the specified publisher AdSense account.
Args:
accountId: string, Account which contains the ad client. (required)
adClientId: string, Ad client which contains the ad unit. (required)
body: object, The request body. (required)
The object takes the form of:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}
Returns:
An object of the form:
{
"status": "A String", # Status of this ad unit. Possible values are:
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
#
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
#
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
"kind": "adsensehost#adUnit", # Kind of resource this is, in this case adsensehost#adUnit.
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
"name": "A String", # Name of this ad unit.
"contentAdsSettings": { # Settings specific to content ads (AFC) and highend mobile content ads (AFMC).
"type": "A String", # Type of this ad unit. Possible values are TEXT, TEXT_IMAGE, IMAGE and LINK.
"backupOption": { # The backup option to be used in instances where no ad is available.
"color": "A String", # Color to use when type is set to COLOR. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # URL to use when type is set to URL.
"type": "A String", # Type of the backup option. Possible values are BLANK, COLOR and URL.
},
"size": "A String", # Size of this ad unit. Size values are in the form SIZE_{width}_{height}.
},
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
"mobileContentAdsSettings": { # Settings specific to WAP mobile content ads (AFMC).
"scriptingLanguage": "A String", # The scripting language to use for this ad unit.
"type": "A String", # Type of this ad unit.
"markupLanguage": "A String", # The markup language to use for this ad unit.
"size": "A String", # Size of this ad unit.
},
"customStyle": { # Custom style information specific to this ad unit.
"corners": "A String", # The style of the corners in the ad. Possible values are SQUARE, SLIGHTLY_ROUNDED and VERY_ROUNDED.
"colors": { # The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
"url": "A String", # The color of the ad url.
"text": "A String", # The color of the ad text.
"border": "A String", # The color of the ad border.
"background": "A String", # The color of the ad background.
"title": "A String", # The color of the ad title.
},
"font": { # The font which is included in the style.
"family": "A String", # The family of the font. Possible values are: ACCOUNT_DEFAULT_FAMILY, ADSENSE_DEFAULT_FAMILY, ARIAL, TIMES and VERDANA.
"size": "A String", # The size of the font. Possible values are: ACCOUNT_DEFAULT_SIZE, ADSENSE_DEFAULT_SIZE, SMALL, MEDIUM and LARGE.
},
"kind": "adsensehost#adStyle", # Kind this is, in this case adsensehost#adStyle.
},
}</pre>
</div>
</body></html>

141
docs/dyn/adsensehost_v4_1.accounts.html
View File

@@ -1,141 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsensehost_v4_1.accounts.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.accounts.adunits.html">adunits()</a></code>
</p>
<p class="firstline">Returns the adunits Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.accounts.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="#get">get(accountId)</a></code></p>
<p class="firstline">Get information about the selected associated AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(filterAdClientId)</a></code></p>
<p class="firstline">List hosted accounts associated with this AdSense account by ad client id.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(filterAdClientId)</code>
<pre>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.
}</pre>
</div>
</body></html>

127
docs/dyn/adsensehost_v4_1.accounts.reports.html
View File

@@ -1,127 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.accounts.html">accounts</a> . <a href="adsensehost_v4_1.accounts.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(accountId, startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(accountId, startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code>
<pre>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",
],
}</pre>
</div>
</body></html>

147
docs/dyn/adsensehost_v4_1.adclients.html
View File

@@ -1,147 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.adclients.html">adclients</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(adClientId)</a></code></p>
<p class="firstline">Get information about one of the ad clients in the Host AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all host ad clients in this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(adClientId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

143
docs/dyn/adsensehost_v4_1.associationsessions.html
View File

@@ -1,143 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.associationsessions.html">associationsessions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#start">start(productCode, websiteUrl, websiteLocale=None, userLocale=None)</a></code></p>
<p class="firstline">Create an association session for initiating an association with an AdSense user.</p>
<p class="toc_element">
<code><a href="#verify">verify(token)</a></code></p>
<p class="firstline">Verify an association session after the association callback returns from AdSense signup.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="start">start(productCode, websiteUrl, websiteLocale=None, userLocale=None)</code>
<pre>Create an association session for initiating an association with an AdSense user.
Args:
productCode: string, Products to associate with the user. (required) (repeated)
Allowed values
AFC - AdSense For Content
AFG - AdSense For Games
AFMC - AdSense For Mobile Content
AFS - AdSense For Search
AFV - AdSense For Video
websiteUrl: string, The URL of the user's hosted website. (required)
websiteLocale: string, The locale of the user's hosted website.
userLocale: string, The preferred locale of the user.
Returns:
An object of the form:
{
"status": "A String", # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
"productCodes": [ # The products to associate with the user. Options: AFC, AFF, AFS, AFMC
"A String",
],
"kind": "adsensehost#associationSession", # Kind of resource this is, in this case adsensehost#associationSession.
"userLocale": "A String", # The preferred locale of the user themselves when going through the AdSense association flow.
"websiteLocale": "A String", # The locale of the user's hosted website.
"redirectUrl": "A String", # Redirect URL of this association session. Used to redirect users into the AdSense association flow.
"websiteUrl": "A String", # The URL of the user's hosted website.
"id": "A String", # Unique identifier of this association session.
"accountId": "A String", # Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
}</pre>
</div>
<div class="method">
<code class="details" id="verify">verify(token)</code>
<pre>Verify an association session after the association callback returns from AdSense signup.
Args:
token: string, The token returned to the association callback URL. (required)
Returns:
An object of the form:
{
"status": "A String", # Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
"productCodes": [ # The products to associate with the user. Options: AFC, AFF, AFS, AFMC
"A String",
],
"kind": "adsensehost#associationSession", # Kind of resource this is, in this case adsensehost#associationSession.
"userLocale": "A String", # The preferred locale of the user themselves when going through the AdSense association flow.
"websiteLocale": "A String", # The locale of the user's hosted website.
"redirectUrl": "A String", # Redirect URL of this association session. Used to redirect users into the AdSense association flow.
"websiteUrl": "A String", # The URL of the user's hosted website.
"id": "A String", # Unique identifier of this association session.
"accountId": "A String", # Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
}</pre>
</div>
</body></html>

263
docs/dyn/adsensehost_v4_1.customchannels.html
View File

@@ -1,263 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.customchannels.html">customchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(adClientId, customChannelId)</a></code></p>
<p class="firstline">Delete a specific custom channel from the host AdSense account.</p>
<p class="toc_element">
<code><a href="#get">get(adClientId, customChannelId)</a></code></p>
<p class="firstline">Get a specific custom channel from the host AdSense account.</p>
<p class="toc_element">
<code><a href="#insert">insert(adClientId, body)</a></code></p>
<p class="firstline">Add a new custom channel to the host AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all host custom channels in this AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(adClientId, customChannelId, body)</a></code></p>
<p class="firstline">Update a custom channel in the host AdSense account. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(adClientId, body)</a></code></p>
<p class="firstline">Update a custom channel in the host AdSense account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(adClientId, customChannelId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(adClientId, customChannelId)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(adClientId, body)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(adClientId, customChannelId, body)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(adClientId, body)</code>
<pre>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.
}</pre>
</div>
</body></html>

107
docs/dyn/adsensehost_v4_1.html
View File

@@ -1,107 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="adsensehost_v4_1.accounts.html">accounts()</a></code>
</p>
<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.adclients.html">adclients()</a></code>
</p>
<p class="firstline">Returns the adclients Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.associationsessions.html">associationsessions()</a></code>
</p>
<p class="firstline">Returns the associationsessions Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.customchannels.html">customchannels()</a></code>
</p>
<p class="firstline">Returns the customchannels Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>
<p class="toc_element">
<code><a href="adsensehost_v4_1.urlchannels.html">urlchannels()</a></code>
</p>
<p class="firstline">Returns the urlchannels Resource.</p>
</body></html>

126
docs/dyn/adsensehost_v4_1.reports.html
View File

@@ -1,126 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#generate">generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</a></code></p>
<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="generate">generate(startDate, endDate, sort=None, locale=None, metric=None, maxResults=None, dimension=None, startIndex=None, filter=None)</code>
<pre>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",
],
}</pre>
</div>
</body></html>

174
docs/dyn/adsensehost_v4_1.urlchannels.html
View File

@@ -1,174 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="adsensehost_v4_1.html">AdSense Host API</a> . <a href="adsensehost_v4_1.urlchannels.html">urlchannels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(adClientId, urlChannelId)</a></code></p>
<p class="firstline">Delete a URL channel from the host AdSense account.</p>
<p class="toc_element">
<code><a href="#insert">insert(adClientId, body)</a></code></p>
<p class="firstline">Add a new URL channel to the host AdSense account.</p>
<p class="toc_element">
<code><a href="#list">list(adClientId, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List all host URL channels in the host AdSense account.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(adClientId, urlChannelId)</code>
<pre>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
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(adClientId, body)</code>
<pre>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
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(adClientId, pageToken=None, maxResults=None)</code>
<pre>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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>

151
docs/dyn/analytics_v3.data.ga.html
View File

@@ -1,151 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a> . <a href="analytics_v3.data.ga.html">ga</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)</a></code></p>
<p class="firstline">Returns Analytics data for a view (profile).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, segment=None, start_index=None)</code>
<pre>Returns Analytics data for a view (profile).
Args:
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.
dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.
filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.
max_results: integer, The maximum number of entries to include in this feed.
segment: string, An Analytics advanced segment to be applied to data.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # Analytics data for a given view (profile).
"kind": "analytics#gaData", # Resource type.
"rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
[
"A String",
],
],
"containsSampledData": True or False, # Determines if Analytics data contains samples.
"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
"itemsPerPage": 42, # The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
"a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
},
"nextLink": "A String", # Link to next page for this Analytics data query.
"id": "A String", # Unique ID for this data response.
"query": { # Analytics data request query parameters.
"max-results": 42, # Maximum results per page.
"sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
"A String",
],
"dimensions": "A String", # List of analytics dimensions.
"start-date": "A String", # Start date.
"start-index": 42, # Start index.
"segment": "A String", # Analytics advanced segment.
"ids": "A String", # Unique table ID.
"metrics": [ # List of analytics metrics.
"A String",
],
"filters": "A String", # Comma-separated list of dimension or metric filters.
"end-date": "A String", # End date.
},
"previousLink": "A String", # Link to previous page for this Analytics data query.
"profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
"webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"tableId": "A String", # Table ID for view (profile).
"profileId": "A String", # View (Profile) ID.
"profileName": "A String", # View (Profile) name.
"accountId": "A String", # Account ID to which this view (profile) belongs.
},
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
{
"dataType": "A String", # Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
"columnType": "A String", # Column Type. Either DIMENSION or METRIC.
"name": "A String", # Column name.
},
],
"selfLink": "A String", # Link to this page.
}</pre>
</div>
</body></html>

92
docs/dyn/analytics_v3.data.html
View File

@@ -1,92 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="analytics_v3.data.ga.html">ga()</a></code>
</p>
<p class="firstline">Returns the ga Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.data.mcf.html">mcf()</a></code>
</p>
<p class="firstline">Returns the mcf Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.data.realtime.html">realtime()</a></code>
</p>
<p class="firstline">Returns the realtime Resource.</p>
</body></html>

158
docs/dyn/analytics_v3.data.mcf.html
View File

@@ -1,158 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a> . <a href="analytics_v3.data.mcf.html">mcf</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Returns Analytics Multi-Channel Funnels data for a view (profile).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(ids, start_date, end_date, metrics, sort=None, dimensions=None, filters=None, max_results=None, start_index=None)</code>
<pre>Returns Analytics Multi-Channel Funnels data for a view (profile).
Args:
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)
metrics: string, A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. (required)
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.
dimensions: string, A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.
filters: string, A comma-separated list of dimension or metric filters to be applied to the Analytics data.
max_results: integer, The maximum number of entries to include in this feed.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # Multi-Channel Funnels data for a given view (profile).
"kind": "analytics#mcfData", # Resource type.
"rows": [ # Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
[
{ # A union object representing a dimension or metric value. Only one of "primitiveValue" or "conversionPathValue" attribute will be populated.
"primitiveValue": "A String", # A primitive dimension value. A primitive metric value.
"conversionPathValue": [ # A conversion path dimension value, containing a list of interactions with their attributes.
{
"nodeValue": "A String", # Node value of an interaction on conversion path. Such as source, medium etc.
"interactionType": "A String", # Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.
},
],
},
],
],
"containsSampledData": True or False, # Determines if the Analytics data contains sampled data.
"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
"itemsPerPage": 42, # The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
"a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
},
"nextLink": "A String", # Link to next page for this Analytics data query.
"id": "A String", # Unique ID for this data response.
"query": { # Analytics data request query parameters.
"max-results": 42, # Maximum results per page.
"sort": [ # List of dimensions or metrics based on which Analytics data is sorted.
"A String",
],
"dimensions": "A String", # List of analytics dimensions.
"start-date": "A String", # Start date.
"start-index": 42, # Start index.
"segment": "A String", # Analytics advanced segment.
"ids": "A String", # Unique table ID.
"metrics": [ # List of analytics metrics.
"A String",
],
"filters": "A String", # Comma-separated list of dimension or metric filters.
"end-date": "A String", # End date.
},
"previousLink": "A String", # Link to previous page for this Analytics data query.
"profileInfo": { # Information for the view (profile), for which the Analytics data was requested.
"webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"tableId": "A String", # Table ID for view (profile).
"profileId": "A String", # View (Profile) ID.
"profileName": "A String", # View (Profile) name.
"accountId": "A String", # Account ID to which this view (profile) belongs.
},
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
{
"dataType": "A String", # Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.
"columnType": "A String", # Column Type. Either DIMENSION or METRIC.
"name": "A String", # Column name.
},
],
"selfLink": "A String", # Link to this page.
}</pre>
</div>
</body></html>

139
docs/dyn/analytics_v3.data.realtime.html
View File

@@ -1,139 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.data.html">data</a> . <a href="analytics_v3.data.realtime.html">realtime</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(ids, metrics, sort=None, dimensions=None, filters=None, max_results=None)</a></code></p>
<p class="firstline">Returns real-time data for a view (profile).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(ids, metrics, sort=None, dimensions=None, filters=None, max_results=None)</code>
<pre>Returns real-time data for a view (profile).
Args:
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. (required)
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for real-time data.
dimensions: string, A comma-separated list of real-time dimensions. E.g., 'ga:medium,ga:city'.
filters: string, A comma-separated list of dimension or metric filters to be applied to real-time data.
max_results: integer, The maximum number of entries to include in this feed.
Returns:
An object of the form:
{ # Real time data for a given view (profile).
"kind": "analytics#realtimeData", # Resource type.
"rows": [ # Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.
[
"A String",
],
],
"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.
"totalsForAllResults": { # Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.
"a_key": "A String", # Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.
},
"id": "A String", # Unique ID for this data response.
"query": { # Real time data request query parameters.
"max-results": 42, # Maximum results per page.
"sort": [ # List of dimensions or metrics based on which real time data is sorted.
"A String",
],
"dimensions": "A String", # List of real time dimensions.
"ids": "A String", # Unique table ID.
"metrics": [ # List of real time metrics.
"A String",
],
"filters": "A String", # Comma-separated list of dimension or metric filters.
},
"profileInfo": { # Information for the view (profile), for which the real time data was requested.
"webPropertyId": "A String", # Web Property ID to which this view (profile) belongs.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"tableId": "A String", # Table ID for view (profile).
"profileId": "A String", # View (Profile) ID.
"profileName": "A String", # View (Profile) name.
"accountId": "A String", # Account ID to which this view (profile) belongs.
},
"columnHeaders": [ # Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.
{
"dataType": "A String", # Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.
"columnType": "A String", # Column Type. Either DIMENSION or METRIC.
"name": "A String", # Column name.
},
],
"selfLink": "A String", # Link to this page.
}</pre>
</div>
</body></html>

87
docs/dyn/analytics_v3.html
View File

@@ -1,87 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="analytics_v3.data.html">data()</a></code>
</p>
<p class="firstline">Returns the data Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.html">management()</a></code>
</p>
<p class="firstline">Returns the management Resource.</p>
</body></html>

117
docs/dyn/analytics_v3.management.accounts.html
View File

@@ -1,117 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists all accounts to which the user has access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(max_results=None, start_index=None)</code>
<pre>Lists all accounts to which the user has access.
Args:
max_results: integer, The maximum number of accounts to include in this response.
start_index: integer, An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#accounts", # Collection type.
"items": [ # A list of accounts.
{ # JSON template for Analytics account entry.
"kind": "analytics#account", # Resource type for Analytics account.
"name": "A String", # Account name.
"created": "A String", # Time the account was created.
"updated": "A String", # Time the account was last modified.
"childLink": { # Child link for an account entry. Points to the list of web properties for this account.
"href": "A String", # Link to the list of web properties for this account.
"type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
},
"id": "A String", # Account ID.
"selfLink": "A String", # Link for this account.
},
],
"itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Previous link for this account collection.
"startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Next link for this account collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
</body></html>

130
docs/dyn/analytics_v3.management.customDataSources.html
View File

@@ -1,130 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.customDataSources.html">customDataSources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">List custom data sources to which the user has access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
<pre>List custom data sources to which the user has access.
Args:
accountId: string, Account Id for the custom data sources to retrieve. (required)
webPropertyId: string, Web property Id for the custom data sources to retrieve. (required)
max_results: integer, The maximum number of custom data sources to include in this response.
start_index: integer, A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#customDataSources", # Collection type.
"items": [ # Collection of custom data sources.
{ # JSON template for an Analytics custom data source.
"kind": "analytics#customDataSource", # Resource type for Analytics custom data source.
"description": "A String", # Description of custom data source.
"created": "A String", # Time this custom data source was created.
"profilesLinked": [ # IDs of views (profiles) linked to the custom data source.
"A String",
],
"updated": "A String", # Time this custom data source was last modified.
"name": "A String", # Name of this custom data source.
"childLink": {
"href": "A String", # Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.
"type": "A String", # Value is "analytics#dailyUploads". Value is "analytics#uploads".
},
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.
"parentLink": { # Parent link for this custom data source. Points to the web property to which this custom data source belongs.
"href": "A String", # Link to the web property to which this custom data source belongs.
"type": "analytics#webproperty", # Value is "analytics#webproperty".
},
"type": "A String", # Type of the custom data source.
"id": "A String", # Custom data source ID.
"selfLink": "A String", # Link for this Analytics custom data source.
"accountId": "A String", # Account ID to which this custom data source belongs.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Link to previous page for this custom data source collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this custom data source collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
</body></html>

182
docs/dyn/analytics_v3.management.dailyUploads.html
View File

@@ -1,182 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.dailyUploads.html">dailyUploads</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(accountId, webPropertyId, customDataSourceId, date, type)</a></code></p>
<p class="firstline">Delete uploaded data for the given date.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)</a></code></p>
<p class="firstline">List daily uploads to which the user has access.</p>
<p class="toc_element">
<code><a href="#upload">upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)</a></code></p>
<p class="firstline">Update/Overwrite data for a custom data source.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(accountId, webPropertyId, customDataSourceId, date, type)</code>
<pre>Delete uploaded data for the given date.
Args:
accountId: string, Account Id associated with daily upload delete. (required)
webPropertyId: string, Web property Id associated with daily upload delete. (required)
customDataSourceId: string, Custom data source Id associated with daily upload delete. (required)
date: string, Date for which data is to be deleted. Date should be formatted as YYYY-MM-DD. (required)
type: string, Type of data for this delete. (required)
Allowed values
cost - Value for specifying cost data upload.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)</code>
<pre>List daily uploads to which the user has access.
Args:
accountId: string, Account Id for the daily uploads to retrieve. (required)
webPropertyId: string, Web property Id for the daily uploads to retrieve. (required)
customDataSourceId: string, Custom data source Id for daily uploads to retrieve. (required)
start_date: string, Start date of the form YYYY-MM-DD. (required)
end_date: string, End date of the form YYYY-MM-DD. (required)
max_results: integer, The maximum number of custom data sources to include in this response.
start_index: integer, A 1-based index of the first daily upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # A daily upload collection lists Analytics daily uploads to which the user has access. Each resource in the collection corresponds to a single Analytics daily upload.
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#dailyUploads", # Collection type. Value is analytics#dailyUploads.
"items": [ # A collection of daily uploads.
{ # Metadata for daily upload entity.
"recentChanges": [ # Change log for last 10 changes in chronological order.
{
"change": "A String", # The type of change: APPEND, RESET, or DELETE.
"time": "A String", # The time when the change occurred.
},
],
"kind": "analytics#dailyUpload", # Resource type for Analytics daily upload.
"modifiedTime": "A String", # Time this daily upload was last modified.
"appendCount": 42, # Number of appends for this date.
"customDataSourceId": "A String", # Custom data source ID to which this daily upload belongs.
"date": "A String", # Date associated with daily upload.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this daily upload belongs.
"createdTime": "A String", # Time this daily upload was created.
"parentLink": { # Parent link for a daily upload. Points to the custom data source to which this daily upload belongs.
"href": "A String", # Link to the custom data source to which this daily upload belongs.
"type": "analytics#customDataSource", # Value is "analytics#customDataSource".
},
"selfLink": "A String", # Link for this daily upload.
"accountId": "A String", # Account ID to which this daily upload belongs.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Link to previous page for this daily upload collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this daily upload collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
<div class="method">
<code class="details" id="upload">upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)</code>
<pre>Update/Overwrite data for a custom data source.
Args:
accountId: string, Account Id associated with daily upload. (required)
webPropertyId: string, Web property Id associated with daily upload. (required)
customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
date: string, Date for which data is uploaded. Date should be formatted as YYYY-MM-DD. (required)
appendNumber: integer, Append number for this upload indexed from 1. (required)
type: string, Type of data for this upload. (required)
Allowed values
cost - Value for specifying cost data upload.
reset: boolean, Reset/Overwrite all previous appends for this date and start over with this file as the first upload.
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # Metadata returned for a successful append operation.
"kind": "analytics#dailyUploadAppend", # Resource type for Analytics daily upload append.
"customDataSourceId": "A String", # Custom data source Id to which this daily upload append belongs.
"appendNumber": 42, # Append number.
"webPropertyId": "A String", # Web property Id of the form UA-XXXXX-YY to which this daily upload append belongs.
"date": "A String", # Date associated with daily upload append.
"nextAppendLink": "A String",
"accountId": "A String", # Account Id to which this daily upload append belongs.
}</pre>
</div>
</body></html>

550
docs/dyn/analytics_v3.management.experiments.html
View File

@@ -1,550 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.experiments.html">experiments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(accountId, webPropertyId, profileId, experimentId)</a></code></p>
<p class="firstline">Delete an experiment.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, profileId, experimentId)</a></code></p>
<p class="firstline">Returns an experiment to which the user has access.</p>
<p class="toc_element">
<code><a href="#insert">insert(accountId, webPropertyId, profileId, body)</a></code></p>
<p class="firstline">Create a new experiment.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists experiments to which the user has access.</p>
<p class="toc_element">
<code><a href="#patch">patch(accountId, webPropertyId, profileId, experimentId, body)</a></code></p>
<p class="firstline">Update an existing experiment. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, webPropertyId, profileId, experimentId, body)</a></code></p>
<p class="firstline">Update an existing experiment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(accountId, webPropertyId, profileId, experimentId)</code>
<pre>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)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, profileId, experimentId)</code>
<pre>Returns an experiment to which the user has access.
Args:
accountId: string, Account ID to retrieve the experiment for. (required)
webPropertyId: string, Web property ID to retrieve the experiment for. (required)
profileId: string, View (Profile) ID to retrieve the experiment for. (required)
experimentId: string, Experiment ID to retrieve the experiment for. (required)
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(accountId, webPropertyId, profileId, body)</code>
<pre>Create a new experiment.
Args:
accountId: string, Account ID to create the experiment for. (required)
webPropertyId: string, Web property ID to create the experiment for. (required)
profileId: string, View (Profile) ID to create the experiment for. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
<pre>Lists experiments to which the user has access.
Args:
accountId: string, Account ID to retrieve experiments for. (required)
webPropertyId: string, Web property ID to retrieve experiments for. (required)
profileId: string, View (Profile) ID to retrieve experiments for. (required)
max_results: integer, The maximum number of experiments to include in this response.
start_index: integer, An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#experiments", # Collection type.
"items": [ # A list of experiments.
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Link to previous page for this experiment collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this experiment collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(accountId, webPropertyId, profileId, experimentId, body)</code>
<pre>Update an existing experiment. This method supports patch semantics.
Args:
accountId: string, Account ID of the experiment to update. (required)
webPropertyId: string, Web property ID of the experiment to update. (required)
profileId: string, View (Profile) ID of the experiment to update. (required)
experimentId: string, Experiment ID of the experiment to update. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, webPropertyId, profileId, experimentId, body)</code>
<pre>Update an existing experiment.
Args:
accountId: string, Account ID of the experiment to update. (required)
webPropertyId: string, Web property ID of the experiment to update. (required)
profileId: string, View (Profile) ID of the experiment to update. (required)
experimentId: string, Experiment ID of the experiment to update. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}
Returns:
An object of the form:
{ # JSON template for Analytics experiment resource.
"trafficCoverage": 3.14, # A floating-point number between 0 and 1. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"webPropertyId": "A String", # Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.
"optimizationType": "A String", # Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED".
"objectiveMetric": "A String", # The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:bounces", "ga:pageviews", "ga:timeOnSite", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API".
"id": "A String", # Experiment ID. Required for patch and update. Disallowed for create.
"accountId": "A String", # Account ID to which this experiment belongs. This field is read-only.
"snippet": "A String", # The snippet of code to include on the control page(s). This field is read-only.
"editableInGaUi": "", # If true, the end user will be able to edit the experiment via the Google Analytics user interface.
"rewriteVariationUrlsAsOriginal": True or False, # Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.
"servingFramework": "", # The framework used to serve the experiment variations and evaluate the results. One of:
# - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.
# - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.
# - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.
"status": "A String", # Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment.
"updated": "A String", # Time the experiment was last modified. This field is read-only.
"description": "A String", # Notes about this experiment.
"reasonExperimentEnded": "A String", # Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.
"internalWebPropertyId": "A String", # Internal ID for the web property to which this experiment belongs. This field is read-only.
"winnerConfidenceLevel": 3.14, # A floating-point number between 0 and 1. Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.
"startTime": "A String", # The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.
"winnerFound": True or False, # Boolean specifying whether a winner has been found for this experiment. This field is read-only.
"kind": "analytics#experiment", # Resource type for an Analytics experiment. This field is read-only.
"name": "A String", # Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.
"created": "A String", # Time the experiment was created. This field is read-only.
"variations": [ # Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.
{
"status": "A String", # Status of the variation. Possible values: "ACTIVE", "INACTIVE". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.
"url": "A String", # The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.
"won": True or False, # True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.
"name": "A String", # The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.
"weight": 3.14, # Weight that this variation should receive. Only present if the experiment is running. This field is read-only.
},
],
"minimumExperimentLengthInDays": 42, # Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.
"profileId": "A String", # View (Profile) ID to which this experiment belongs. This field is read-only.
"parentLink": { # Parent link for an experiment. Points to the view (profile) to which this experiment belongs.
"href": "A String", # Link to the view (profile) to which this experiment belongs. This field is read-only.
"type": "analytics#profile", # Value is "analytics#profile". This field is read-only.
},
"endTime": "A String", # The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.
"selfLink": "A String", # Link for this experiment. This field is read-only.
}</pre>
</div>
</body></html>

160
docs/dyn/analytics_v3.management.goals.html
View File

@@ -1,160 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.goals.html">goals</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists goals to which the user has access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code>
<pre>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.
}</pre>
</div>
</body></html>

117
docs/dyn/analytics_v3.management.html
View File

@@ -1,117 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="analytics_v3.management.accounts.html">accounts()</a></code>
</p>
<p class="firstline">Returns the accounts Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.customDataSources.html">customDataSources()</a></code>
</p>
<p class="firstline">Returns the customDataSources Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.dailyUploads.html">dailyUploads()</a></code>
</p>
<p class="firstline">Returns the dailyUploads Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.experiments.html">experiments()</a></code>
</p>
<p class="firstline">Returns the experiments Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.goals.html">goals()</a></code>
</p>
<p class="firstline">Returns the goals Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.profiles.html">profiles()</a></code>
</p>
<p class="firstline">Returns the profiles Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.segments.html">segments()</a></code>
</p>
<p class="firstline">Returns the segments Resource.</p>
<p class="toc_element">
<code><a href="analytics_v3.management.webproperties.html">webproperties()</a></code>
</p>
<p class="firstline">Returns the webproperties Resource.</p>
</body></html>

135
docs/dyn/analytics_v3.management.profiles.html
View File

@@ -1,135 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.profiles.html">profiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists views (profiles) to which the user has access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
<pre>Lists views (profiles) to which the user has access.
Args:
accountId: string, Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
webPropertyId: string, Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
max_results: integer, The maximum number of views (profiles) to include in this response.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#profiles", # Collection type.
"items": [ # A list of views (profiles).
{ # JSON template for an Analytics view (profile).
"defaultPage": "A String", # Default page for this view (profile).
"kind": "analytics#profile", # Resource type for Analytics profile.
"excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
"name": "A String", # Name of this view (profile).
"created": "A String", # Time this view (profile) was created.
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
"updated": "A String", # Time this view (profile) was last modified.
"siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
"websiteUrl": "A String", # Website URL for this view (profile).
"currency": "A String", # The currency type associated with this view (profile).
"internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
"childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
"href": "A String", # Link to the list of goals for this view (profile).
"type": "analytics#goals", # Value is "analytics#goals".
},
"eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
"timezone": "A String", # Time zone for which this profile has been configured.
"siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
"parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
"href": "A String", # Link to the web property to which this view (profile) belongs.
"type": "analytics#webproperty", # Value is "analytics#webproperty".
},
"type": "A String", # View (Profile) type. Supported types: WEB or APP.
"id": "A String", # View (Profile) ID.
"selfLink": "A String", # Link for this view (profile).
"accountId": "A String", # Account ID to which this view (profile) belongs.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Link to previous page for this view (profile) collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this view (profile) collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
</body></html>

115
docs/dyn/analytics_v3.management.segments.html
View File

@@ -1,115 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.segments.html">segments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists advanced segments to which the user has access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(max_results=None, start_index=None)</code>
<pre>Lists advanced segments to which the user has access.
Args:
max_results: integer, The maximum number of advanced segments to include in this response.
start_index: integer, An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # An advanced segment collection lists Analytics advanced segments that the user has access to. Each resource in the collection corresponds to a single Analytics advanced segment.
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#segments", # Collection type for advanced segments.
"items": [ # A list of advanced segments.
{ # JSON template for an Analytics advanced segment.
"definition": "A String", # Advanced segment definition.
"kind": "analytics#segment", # Resource type for Analytics advanced segment.
"segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.
"created": "A String", # Time the advanced segment was created.
"updated": "A String", # Time the advanced segment was last modified.
"id": "A String", # Advanced segment ID.
"selfLink": "A String", # Link for this advanced segment.
"name": "A String", # Advanced segment name.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Link to previous page for this advanced segment collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this advanced segment collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
</body></html>

128
docs/dyn/analytics_v3.management.webproperties.html
View File

@@ -1,128 +0,0 @@
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.webproperties.html">webproperties</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">Lists web properties to which the user has access.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(accountId, max_results=None, start_index=None)</code>
<pre>Lists web properties to which the user has access.
Args:
accountId: string, Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
max_results: integer, The maximum number of web properties to include in this response.
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
Returns:
An object of the form:
{ # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
"username": "A String", # Email ID of the authenticated user
"kind": "analytics#webproperties", # Collection type.
"items": [ # A list of web properties.
{ # JSON template for an Analytics web property.
"websiteUrl": "A String", # Website url for this web property.
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
"name": "A String", # Name of this web property.
"created": "A String", # Time this web property was created.
"level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
"updated": "A String", # Time this web property was last modified.
"profileCount": 42, # View (Profile) count for this web property.
"internalWebPropertyId": "A String", # Internal ID for this web property.
"childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
"href": "A String", # Link to the list of views (profiles) for this web property.
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
},
"industryVertical": "A String", # The industry vertical/category selected for this web property.
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
"href": "A String", # Link to the account for this web property.
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
},
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
"selfLink": "A String", # Link for this web property.
"accountId": "A String", # Account ID to which this web property belongs.
},
],
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
"previousLink": "A String", # Link to previous page for this web property collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this web property collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
}</pre>
</div>
</body></html>

Some files were not shown because too many files have changed in this diff Show More