Refresh generated docs.
This commit is contained in:
Joe Gregorio
@@ -339,7 +339,8 @@ def document_api(name, version):
|
||||
if __name__ == '__main__':
|
||||
http = httplib2.Http()
|
||||
resp, content = http.request(
|
||||
'https://www.googleapis.com/discovery/v1/apis?preferred=true')
|
||||
'https://www.googleapis.com/discovery/v1/apis?preferred=true',
|
||||
headers={'X-User-IP': '0.0.0.0'})
|
||||
if resp.status == 200:
|
||||
directory = simplejson.loads(content)['items']
|
||||
for api in directory:
|
||||
|
||||
@@ -1,168 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one account by ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: integer, The account id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#account", # Resource type.<br>
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.<br>
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.<br>
|
||||
{<br>
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.<br>
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.<br>
|
||||
"id": 42, # Account id.<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the authenticated user's list of accounts.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # A list of accounts.<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#account", # Resource type.<br>
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.<br>
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.<br>
|
||||
{<br>
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.<br>
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.<br>
|
||||
"id": 42, # Account id.<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#accountsList", # Resource type.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an existing account. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#account", # Resource type.<br>
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.<br>
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.<br>
|
||||
{<br>
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.<br>
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.<br>
|
||||
"id": 42, # Account id.<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: integer, The account id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#account", # Resource type.<br>
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.<br>
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.<br>
|
||||
{<br>
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.<br>
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.<br>
|
||||
"id": 42, # Account id.<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an existing account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#account", # Resource type.<br>
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.<br>
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.<br>
|
||||
{<br>
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.<br>
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.<br>
|
||||
"id": 42, # Account id.<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: integer, The account id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#account", # Resource type.<br>
|
||||
"maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.<br>
|
||||
"bidderLocation": [ # Your bidder locations that have distinct URLs.<br>
|
||||
{<br>
|
||||
"url": "A String", # The URL to which the Ad Exchange will send bid requests.<br>
|
||||
"maximumQps": 42, # The maximum queries per second the Ad Exchange will send.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.<br>
|
||||
"id": 42, # Account id.<br>
|
||||
"cookieMatchingUrl": "A String", # The base URL used in cookie match requests.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,208 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the status for a single creative.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
adgroupId: string, The adgroup this creative belongs to. (required)<br>
|
||||
trace: string, A parameter<br>
|
||||
pp: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
buyerCreativeId: string, The buyer-specific id for this creative. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: integer, The id for the account that will serve this creative. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.<br>
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.<br>
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.<br>
|
||||
"width": 42, # Ad width.<br>
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creative", # Resource type.<br>
|
||||
"height": 42, # Ad height.<br>
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.<br>
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.<br>
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.<br>
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Submit a new creative.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.<br>
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.<br>
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.<br>
|
||||
"width": 42, # Ad width.<br>
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creative", # Resource type.<br>
|
||||
"height": 42, # Ad height.<br>
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.<br>
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.<br>
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.<br>
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.<br>
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.<br>
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.<br>
|
||||
"width": 42, # Ad width.<br>
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creative", # Resource type.<br>
|
||||
"height": 42, # Ad height.<br>
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.<br>
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.<br>
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.<br>
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of the authenticated user's active creatives.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # A list of creatives.<br>
|
||||
{<br>
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.<br>
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.<br>
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.<br>
|
||||
"width": 42, # Ad width.<br>
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creative", # Resource type.<br>
|
||||
"height": 42, # Ad height.<br>
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.<br>
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.<br>
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.<br>
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.<br>
|
||||
42,<br>
|
||||
],<br>
|
||||
"accountId": 42, # Account id.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adexchangebuyer#creativesList", # Resource type.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,78 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one direct deal by ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
id: string, The direct deal id (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"advertiser": "A String", # The name of the advertiser this deal is for.<br>
|
||||
"kind": "adexchangebuyer#directDeal", # Resource type.<br>
|
||||
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.<br>
|
||||
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.<br>
|
||||
"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.<br>
|
||||
"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.<br>
|
||||
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.<br>
|
||||
"id": "A String", # Deal id.<br>
|
||||
"accountId": 42, # The account id of the buyer this deal is for.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the authenticated user's list of direct deals.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adexchangebuyer#directDealsList", # Resource type.<br>
|
||||
"directDeals": [ # A list of direct deals relevant for your account.<br>
|
||||
{<br>
|
||||
"advertiser": "A String", # The name of the advertiser this deal is for.<br>
|
||||
"kind": "adexchangebuyer#directDeal", # Resource type.<br>
|
||||
"currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.<br>
|
||||
"fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.<br>
|
||||
"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.<br>
|
||||
"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.<br>
|
||||
"sellerNetwork": "A String", # The name of the publisher offering this direct deal.<br>
|
||||
"id": "A String", # Deal id.<br>
|
||||
"accountId": 42, # The account id of the buyer this deal is for.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-accounts"><strong><a href="adexchangebuyer.v1.accounts.html">accounts</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-creatives"><strong><a href="adexchangebuyer.v1.creatives.html">creatives</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-directDeals"><strong><a href="adexchangebuyer.v1.directDeals.html">directDeals</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
228
docs/dyn/adexchangebuyer_v1.accounts.html
Normal file
228
docs/dyn/adexchangebuyer_v1.accounts.html
Normal file
@@ -0,0 +1,228 @@
|
||||
<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.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1.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:
|
||||
|
||||
{
|
||||
"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.
|
||||
"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:
|
||||
|
||||
{
|
||||
"items": [ # A list of accounts.
|
||||
{
|
||||
"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.
|
||||
"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:
|
||||
|
||||
{
|
||||
"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.
|
||||
"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:
|
||||
|
||||
{
|
||||
"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.
|
||||
"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:
|
||||
|
||||
{
|
||||
"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.
|
||||
"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:
|
||||
|
||||
{
|
||||
"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.
|
||||
"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>
|
||||
266
docs/dyn/adexchangebuyer_v1.creatives.html
Normal file
266
docs/dyn/adexchangebuyer_v1.creatives.html
Normal file
@@ -0,0 +1,266 @@
|
||||
<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.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1.creatives.html">creatives</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(accountId, buyerCreativeId, adgroupId)</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)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of the authenticated user's active creatives.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(accountId, buyerCreativeId, adgroupId)</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)
|
||||
adgroupId: string, The adgroup this creative belongs to. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
}</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:
|
||||
|
||||
{
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(pageToken=None, maxResults=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.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [ # A list of creatives.
|
||||
{
|
||||
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"advertiserName": "A String", # The name of the company being advertised in the creative.
|
||||
"adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
|
||||
"videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
|
||||
"width": 42, # Ad width.
|
||||
"attribute": [ # All attributes for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"kind": "adexchangebuyer#creative", # Resource type.
|
||||
"height": 42, # Ad height.
|
||||
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
|
||||
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
|
||||
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
|
||||
"clickThroughUrl": [ # The set of destination urls for the snippet.
|
||||
"A String",
|
||||
],
|
||||
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
|
||||
42,
|
||||
],
|
||||
"disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
|
||||
"A String",
|
||||
],
|
||||
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
|
||||
42,
|
||||
],
|
||||
"accountId": 42, # Account id.
|
||||
},
|
||||
],
|
||||
"kind": "adexchangebuyer#creativesList", # Resource type.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
134
docs/dyn/adexchangebuyer_v1.directDeals.html
Normal file
134
docs/dyn/adexchangebuyer_v1.directDeals.html
Normal file
@@ -0,0 +1,134 @@
|
||||
<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.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1.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:
|
||||
|
||||
{
|
||||
"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:
|
||||
|
||||
{
|
||||
"kind": "adexchangebuyer#directDealsList", # Resource type.
|
||||
"directDeals": [ # A list of direct deals relevant for your account.
|
||||
{
|
||||
"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.html
Normal file
92
docs/dyn/adexchangebuyer_v1.html
Normal file
@@ -0,0 +1,92 @@
|
||||
<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.html">Ad Exchange Buyer API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1.accounts.html">accounts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the accounts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1.creatives.html">creatives()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the creatives Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adexchangebuyer_v1.directDeals.html">directDeals()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the directDeals Resource.</p>
|
||||
|
||||
</body></html>
|
||||
@@ -1,64 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad clients in the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account for which to list ad clients. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad clients returned in this list response.<br>
|
||||
{<br>
|
||||
"productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.<br>
|
||||
"kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.<br>
|
||||
"id": "A String", # Unique identifier of this ad client.<br>
|
||||
"supportsReporting": True or False, # Whether this ad client supports being reported on.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,72 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels which the specified ad unit belongs to.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client which contains the ad unit. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit for which to list custom channels. (required)<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The custom channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.<br>
|
||||
"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.<br>
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.<br>
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.<br>
|
||||
"description": "A String", # The external description of the channel.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,101 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-customchannels"><strong><a href="adsense.v1.1.accounts.adunits.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the specified ad unit in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
adClientId: string, Ad client for which to get the ad unit. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit to retrieve. (required)<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
adClientId: string, Ad client for which to list ad units. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad units returned in this list response.<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,73 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified custom channel.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
customChannelId: string, Custom channel for which to list ad units. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad units returned in this list response.<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,100 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adunits"><strong><a href="adsense.v1.1.accounts.customchannels.adunits.html">adunits</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get the specified custom channel from the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
customChannelId: string, Custom channel to retrieve. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.<br>
|
||||
"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.<br>
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.<br>
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.<br>
|
||||
"description": "A String", # The external description of the channel.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client for which to list custom channels. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The custom channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.<br>
|
||||
"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.<br>
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.<br>
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.<br>
|
||||
"description": "A String", # The external description of the channel.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,97 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adclients"><strong><a href="adsense.v1.1.accounts.adclients.html">adclients</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adunits"><strong><a href="adsense.v1.1.accounts.adunits.html">adunits</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-customchannels"><strong><a href="adsense.v1.1.accounts.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get information about the selected AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
tree: boolean, Whether the tree of sub accounts should be returned.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to get information about. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adsense#account", # Kind of resource this is, in this case adsense#account.<br>
|
||||
"id": "A String", # Unique identifier of this account.<br>
|
||||
"subAccounts": [ # Sub accounts of the this account.<br>
|
||||
# Object with schema name: Account<br>
|
||||
],<br>
|
||||
"name": "A String", # Name of this account.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all accounts available to this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
maxResults: integer, The maximum number of accounts to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The accounts returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#account", # Kind of resource this is, in this case adsense#account.<br>
|
||||
"id": "A String", # Unique identifier of this account.<br>
|
||||
"subAccounts": [ # Sub accounts of the this account.<br>
|
||||
# Object with schema name: Account<br>
|
||||
],<br>
|
||||
"name": "A String", # Name of this account.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#accounts", # Kind of list this is, in this case adsense#accounts.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-reports"><strong><a href="adsense.v1.1.accounts.reports.html">reports</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-urlchannels"><strong><a href="adsense.v1.1.accounts.urlchannels.html">urlchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,74 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>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.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.<br>
|
||||
metric: string, Numeric columns to include in the report. (repeated)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
accountId: string, Account upon which to report. (required)<br>
|
||||
pp: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
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)<br>
|
||||
trace: string, A parameter<br>
|
||||
maxResults: integer, The maximum number of rows of report data to return.<br>
|
||||
filter: string, Filters to be run on the report. (repeated)<br>
|
||||
userip: string, A parameter<br>
|
||||
dimension: string, Dimensions to base the report on. (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.<br>
|
||||
"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.<br>
|
||||
[<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
],<br>
|
||||
"warnings": [ # Any warnings associated with generation of the report.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
{<br>
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.<br>
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.<br>
|
||||
"name": "A String", # The name of the header.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,64 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all URL channels in the specified ad client for the specified account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client for which to list URL channels. (required)<br>
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
accountId: string, Account to which the ad client belongs. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The URL channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.<br>
|
||||
"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.<br>
|
||||
"urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,63 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad clients in this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad clients returned in this list response.<br>
|
||||
{<br>
|
||||
"productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.<br>
|
||||
"kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.<br>
|
||||
"id": "A String", # Unique identifier of this ad client.<br>
|
||||
"supportsReporting": True or False, # Whether this ad client supports being reported on.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,71 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels which the specified ad unit belongs to.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client which contains the ad unit. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit for which to list custom channels. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The custom channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.<br>
|
||||
"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.<br>
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.<br>
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.<br>
|
||||
"description": "A String", # The external description of the channel.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,99 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-customchannels"><strong><a href="adsense.v1.1.adunits.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the specified ad unit in the specified ad client.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
adClientId: string, Ad client for which to get the ad unit. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
adUnitId: string, Ad unit to retrieve. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified ad client for this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
adClientId: string, Ad client for which to list ad units. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad units returned in this list response.<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,72 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in the specified custom channel.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
customChannelId: string, Custom channel for which to list ad units. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad units returned in this list response.<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,98 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adunits"><strong><a href="adsense.v1.1.customchannels.adunits.html">adunits</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get the specified custom channel from the specified ad client.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
customChannelId: string, Custom channel to retrieve. (required)<br>
|
||||
adClientId: string, Ad client which contains the custom channel. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.<br>
|
||||
"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.<br>
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.<br>
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.<br>
|
||||
"description": "A String", # The external description of the channel.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels in the specified ad client for this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client for which to list custom channels. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The custom channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"targetingInfo": { # The targeting information of this custom channel, if activated.<br>
|
||||
"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.<br>
|
||||
"adsAppearOn": "A String", # The name used to describe this channel externally.<br>
|
||||
"siteLanguage": "A String", # The language of the sites ads will be displayed on.<br>
|
||||
"description": "A String", # The external description of the channel.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,38 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-accounts"><strong><a href="adsense.v1.1.accounts.html">accounts</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adclients"><strong><a href="adsense.v1.1.adclients.html">adclients</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adunits"><strong><a href="adsense.v1.1.adunits.html">adunits</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-customchannels"><strong><a href="adsense.v1.1.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-reports"><strong><a href="adsense.v1.1.reports.html">reports</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-urlchannels"><strong><a href="adsense.v1.1.urlchannels.html">urlchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,74 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>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.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.<br>
|
||||
metric: string, Numeric columns to include in the report. (repeated)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
accountId: string, Accounts upon which to report. (repeated)<br>
|
||||
pp: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
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)<br>
|
||||
trace: string, A parameter<br>
|
||||
maxResults: integer, The maximum number of rows of report data to return.<br>
|
||||
filter: string, Filters to be run on the report. (repeated)<br>
|
||||
userip: string, A parameter<br>
|
||||
dimension: string, Dimensions to base the report on. (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.<br>
|
||||
"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.<br>
|
||||
[<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
],<br>
|
||||
"warnings": [ # Any warnings associated with generation of the report.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
{<br>
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.<br>
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.<br>
|
||||
"name": "A String", # The name of the header.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,63 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all URL channels in the specified ad client for this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client for which to list URL channels. (required)<br>
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The URL channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.<br>
|
||||
"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.<br>
|
||||
"urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,59 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad clients in this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
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.<br>
|
||||
maxResults: integer, The maximum number of ad clients to include in the response, used for paging.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad clients returned in this list response.<br>
|
||||
{<br>
|
||||
"productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.<br>
|
||||
"kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.<br>
|
||||
"id": "A String", # Unique identifier of this ad client.<br>
|
||||
"supportsReporting": True or False, # Whether this ad client supports being reported on.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,67 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all ad units in this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
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.<br>
|
||||
includeInactive: boolean, Whether to include inactive ad units. Default: true.<br>
|
||||
adClientId: string, Ad client for which to list ad units. (required)<br>
|
||||
maxResults: integer, The maximum number of ad units to include in the response, used for paging.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The ad units returned in this list response.<br>
|
||||
{<br>
|
||||
"status": "A String", # Status of this ad unit. Possible values are:<br>
|
||||
# NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.<br>
|
||||
#<br>
|
||||
# ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.<br>
|
||||
#<br>
|
||||
# INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.<br>
|
||||
"kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.<br>
|
||||
"code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this ad unit.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,60 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all custom channels in this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client for which to list custom channels. (required)<br>
|
||||
maxResults: integer, The maximum number of custom channels to include in the response, used for paging.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The custom channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.<br>
|
||||
"code": "A String", # Code of this custom channel, not necessarily unique across ad clients.<br>
|
||||
"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.<br>
|
||||
"name": "A String", # Name of this custom channel.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,36 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adclients"><strong><a href="adsense.v1.adclients.html">adclients</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-adunits"><strong><a href="adsense.v1.adunits.html">adunits</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-customchannels"><strong><a href="adsense.v1.customchannels.html">customchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-reports"><strong><a href="adsense.v1.reports.html">reports</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-urlchannels"><strong><a href="adsense.v1.urlchannels.html">urlchannels</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,69 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-generate"><strong>generate</strong></a> = method(self, **kwargs)</dt><dd><tt>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.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
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)<br>
|
||||
startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)<br>
|
||||
currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.<br>
|
||||
locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.<br>
|
||||
metric: string, Numeric columns to include in the report. (repeated)<br>
|
||||
maxResults: integer, The maximum number of rows of report data to return.<br>
|
||||
filter: string, Filters to be run on the report. (repeated)<br>
|
||||
startIndex: integer, Index of the first row of report data to return.<br>
|
||||
dimension: string, Dimensions to base the report on. (repeated)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "adsense#report", # Kind this is, in this case adsense#report.<br>
|
||||
"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.<br>
|
||||
[<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
],<br>
|
||||
"warnings": [ # Any warnings associated with generation of the report.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
{<br>
|
||||
"currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.<br>
|
||||
"type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.<br>
|
||||
"name": "A String", # The name of the header.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"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.<br>
|
||||
"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.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,59 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all URL channels in this AdSense account.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
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.<br>
|
||||
adClientId: string, Ad client for which to list URL channels. (required)<br>
|
||||
maxResults: integer, The maximum number of URL channels to include in the response, used for paging.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"items": [ # The URL channels returned in this list response.<br>
|
||||
{<br>
|
||||
"kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.<br>
|
||||
"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.<br>
|
||||
"urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.<br>
|
||||
"etag": "A String", # ETag of this response for caching purposes.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
125
docs/dyn/adsense_v1_1.accounts.adclients.html
Normal file
125
docs/dyn/adsense_v1_1.accounts.adclients.html
Normal file
@@ -0,0 +1,125 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.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.
|
||||
"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_1.accounts.adunits.customchannels.html
Normal file
133
docs/dyn/adsense_v1_1.accounts.adunits.customchannels.html
Normal file
@@ -0,0 +1,133 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.accounts.adunits.html">adunits</a> . <a href="adsense_v1_1.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>
|
||||
167
docs/dyn/adsense_v1_1.accounts.adunits.html
Normal file
167
docs/dyn/adsense_v1_1.accounts.adunits.html
Normal file
@@ -0,0 +1,167 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.accounts.adunits.html">adunits</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.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.
|
||||
"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(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.
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</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/adsense_v1_1.accounts.customchannels.adunits.html
Normal file
134
docs/dyn/adsense_v1_1.accounts.customchannels.adunits.html
Normal file
@@ -0,0 +1,134 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.accounts.customchannels.html">customchannels</a> . <a href="adsense_v1_1.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.
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</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_1.accounts.customchannels.html
Normal file
166
docs/dyn/adsense_v1_1.accounts.customchannels.html
Normal file
@@ -0,0 +1,166 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.accounts.customchannels.html">customchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.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>
|
||||
175
docs/dyn/adsense_v1_1.accounts.html
Normal file
175
docs/dyn/adsense_v1_1.accounts.html
Normal file
@@ -0,0 +1,175 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.accounts.adclients.html">adclients()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adclients Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.accounts.adunits.html">adunits()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adunits Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.accounts.customchannels.html">customchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.accounts.reports.html">reports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the reports Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.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.
|
||||
"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.
|
||||
"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>
|
||||
154
docs/dyn/adsense_v1_1.accounts.reports.html
Normal file
154
docs/dyn/adsense_v1_1.accounts.reports.html
Normal file
@@ -0,0 +1,154 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.accounts.reports.html">reports</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<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>
|
||||
125
docs/dyn/adsense_v1_1.accounts.urlchannels.html
Normal file
125
docs/dyn/adsense_v1_1.accounts.urlchannels.html
Normal file
@@ -0,0 +1,125 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.accounts.html">accounts</a> . <a href="adsense_v1_1.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>
|
||||
124
docs/dyn/adsense_v1_1.adclients.html
Normal file
124
docs/dyn/adsense_v1_1.adclients.html
Normal file
@@ -0,0 +1,124 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.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.
|
||||
"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_1.adunits.customchannels.html
Normal file
132
docs/dyn/adsense_v1_1.adunits.customchannels.html
Normal file
@@ -0,0 +1,132 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.adunits.html">adunits</a> . <a href="adsense_v1_1.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>
|
||||
165
docs/dyn/adsense_v1_1.adunits.html
Normal file
165
docs/dyn/adsense_v1_1.adunits.html
Normal file
@@ -0,0 +1,165 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.adunits.html">adunits</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.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.
|
||||
"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 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.
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</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_1.customchannels.adunits.html
Normal file
133
docs/dyn/adsense_v1_1.customchannels.adunits.html
Normal file
@@ -0,0 +1,133 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.customchannels.html">customchannels</a> . <a href="adsense_v1_1.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.
|
||||
"id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
||||
"name": "A String", # Name of this ad unit.
|
||||
},
|
||||
],
|
||||
"kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
|
||||
"etag": "A String", # ETag of this response for caching purposes.
|
||||
}</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_1.customchannels.html
Normal file
164
docs/dyn/adsense_v1_1.customchannels.html
Normal file
@@ -0,0 +1,164 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.customchannels.html">customchannels</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.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>
|
||||
107
docs/dyn/adsense_v1_1.html
Normal file
107
docs/dyn/adsense_v1_1.html
Normal file
@@ -0,0 +1,107 @@
|
||||
<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_1.html">AdSense Management API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.accounts.html">accounts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the accounts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.adclients.html">adclients()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adclients Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.adunits.html">adunits()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the adunits Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.customchannels.html">customchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the customchannels Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.reports.html">reports()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the reports Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="adsense_v1_1.urlchannels.html">urlchannels()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the urlchannels Resource.</p>
|
||||
|
||||
</body></html>
|
||||
154
docs/dyn/adsense_v1_1.reports.html
Normal file
154
docs/dyn/adsense_v1_1.reports.html
Normal file
@@ -0,0 +1,154 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.reports.html">reports</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<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>
|
||||
124
docs/dyn/adsense_v1_1.urlchannels.html
Normal file
124
docs/dyn/adsense_v1_1.urlchannels.html
Normal file
@@ -0,0 +1,124 @@
|
||||
<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_1.html">AdSense Management API</a> . <a href="adsense_v1_1.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>
|
||||
@@ -1,96 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns Analytics data for a profile.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.<br>
|
||||
pp: string, A parameter<br>
|
||||
end_date: string, End date for fetching Analytics data. All requests should specify an end date formatted as YYYY-MM-DD. (required)<br>
|
||||
dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.<br>
|
||||
userip: string, A parameter<br>
|
||||
filters: string, A comma-separated list of dimension or metric filters to be applied to Analytics data.<br>
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)<br>
|
||||
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of entries to include in this feed.<br>
|
||||
trace: string, A parameter<br>
|
||||
segment: string, An Analytics advanced segment to be applied to data.<br>
|
||||
start_date: string, Start date for fetching Analytics data. All requests should specify a start date formatted as YYYY-MM-DD. (required)<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "analytics#gaData", # Resource type.<br>
|
||||
"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.<br>
|
||||
[<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
],<br>
|
||||
"containsSampledData": True or False, # Determines if Analytics data contains samples.<br>
|
||||
"totalResults": 42, # The total number of rows for the query, regardless of the number of rows in the response.<br>
|
||||
"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.<br>
|
||||
"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.<br>
|
||||
},<br>
|
||||
"nextLink": "A String", # Link to next page for this Analytics data query.<br>
|
||||
"id": "A String", # Unique ID for this data response.<br>
|
||||
"query": { # Analytics data request query parameters.<br>
|
||||
"max-results": 42, # Maximum results per page.<br>
|
||||
"sort": [ # List of dimensions or metrics based on which Analytics data is sorted.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"dimensions": "A String", # List of analytics dimensions.<br>
|
||||
"start-date": "A String", # Start date.<br>
|
||||
"start-index": 42, # Start index.<br>
|
||||
"segment": "A String", # Analytics advanced segment.<br>
|
||||
"ids": "A String", # Unique table ID.<br>
|
||||
"metrics": [ # List of analytics metrics.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"filters": "A String", # Comma-separated list of dimension or metric filters.<br>
|
||||
"end-date": "A String", # End date.<br>
|
||||
},<br>
|
||||
"previousLink": "A String", # Link to previous page for this Analytics data query.<br>
|
||||
"profileInfo": { # Information for the profile, for which the Analytics data was requested.<br>
|
||||
"webPropertyId": "A String", # Web Property ID to which this profile belongs.<br>
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.<br>
|
||||
"tableId": "A String", # Table ID for profile.<br>
|
||||
"profileId": "A String", # Profile ID.<br>
|
||||
"profileName": "A String", # Profile name.<br>
|
||||
"accountId": "A String", # Account ID to which this profile belongs.<br>
|
||||
},<br>
|
||||
"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.<br>
|
||||
{<br>
|
||||
"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.<br>
|
||||
"columnType": "A String", # Column Type. Either DIMENSION or METRIC.<br>
|
||||
"name": "A String", # Column name.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"selfLink": "A String", # Link to this page.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,28 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-ga"><strong><a href="analytics.v3.data.ga.html">ga</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,30 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-data"><strong><a href="analytics.v3.data.html">data</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-management"><strong><a href="analytics.v3.management.html">management</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,63 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all accounts to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of accounts to include in this response.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"username": "A String", # Email ID of the authenticated user<br>
|
||||
"kind": "analytics#accounts", # Collection type.<br>
|
||||
"items": [ # A list of accounts.<br>
|
||||
{<br>
|
||||
"kind": "analytics#account", # Resource type for Analytics account.<br>
|
||||
"name": "A String", # Account name.<br>
|
||||
"created": "A String", # Time the account was created.<br>
|
||||
"updated": "A String", # Time the account was last modified.<br>
|
||||
"childLink": { # Child link for an account entry. Points to the list of web properties for this account.<br>
|
||||
"href": "A String", # Link to the list of web properties for this account.<br>
|
||||
"type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".<br>
|
||||
},<br>
|
||||
"id": "A String", # Account ID.<br>
|
||||
"selfLink": "A String", # Link for this account.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br>
|
||||
"previousLink": "A String", # Previous link for this account collection.<br>
|
||||
"startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.<br>
|
||||
"nextLink": "A String", # Next link for this account collection.<br>
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,106 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists goals to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of goals to include in this response.<br>
|
||||
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)<br>
|
||||
userip: string, A parameter<br>
|
||||
profileId: string, Profile ID to retrieve goals for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)<br>
|
||||
start_index: integer, An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
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)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"username": "A String", # Email ID of the authenticated user<br>
|
||||
"kind": "analytics#goals", # Collection type.<br>
|
||||
"items": [ # A list of goals.<br>
|
||||
{<br>
|
||||
"kind": "analytics#goal", # Resource type for an Analytics goal.<br>
|
||||
"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.<br>
|
||||
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.<br>
|
||||
"comparisonValue": "A String", # Value used for this comparison.<br>
|
||||
},<br>
|
||||
"name": "A String", # Goal name.<br>
|
||||
"created": "A String", # Time this goal was created.<br>
|
||||
"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.<br>
|
||||
"url": "A String", # URL for this goal.<br>
|
||||
"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.<br>
|
||||
"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.<br>
|
||||
"steps": [ # List of steps configured for this goal funnel.<br>
|
||||
{<br>
|
||||
"url": "A String", # URL for this step.<br>
|
||||
"name": "A String", # Step name.<br>
|
||||
"number": 42, # Step number.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"firstStepRequired": True or False, # Determines if the first step in this goal is required.<br>
|
||||
},<br>
|
||||
"updated": "A String", # Time this goal was last modified.<br>
|
||||
"value": 3.14, # Goal value.<br>
|
||||
"visitNumPagesDetails": { # Details for the goal of the type VISIT_NUM_PAGES.<br>
|
||||
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.<br>
|
||||
"comparisonValue": "A String", # Value used for this comparison.<br>
|
||||
},<br>
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this goal belongs.<br>
|
||||
"eventDetails": { # Details for the goal of the type EVENT.<br>
|
||||
"eventConditions": [ # List of event conditions.<br>
|
||||
{<br>
|
||||
"type": "A String", # Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.<br>
|
||||
"matchType": "A String", # Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.<br>
|
||||
"expression": "A String", # Expression used for this match.<br>
|
||||
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.<br>
|
||||
"comparisonValue": "A String", # Value used for this comparison.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"useEventValue": True or False, # Determines if the event value should be used as the value for this goal.<br>
|
||||
},<br>
|
||||
"webPropertyId": "A String", # Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.<br>
|
||||
"active": True or False, # Determines whether this goal is active.<br>
|
||||
"profileId": "A String", # Profile ID to which this goal belongs.<br>
|
||||
"parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.<br>
|
||||
"href": "A String", # Link to the profile to which this goal belongs.<br>
|
||||
"type": "analytics#profile", # Value is "analytics#profile".<br>
|
||||
},<br>
|
||||
"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.<br>
|
||||
"id": "A String", # Goal ID.<br>
|
||||
"selfLink": "A String", # Link for this goal.<br>
|
||||
"accountId": "A String", # Account ID to which this goal belongs.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br>
|
||||
"previousLink": "A String", # Link to previous page for this goal collection.<br>
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.<br>
|
||||
"nextLink": "A String", # Link to next page for this goal collection.<br>
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,36 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-accounts"><strong><a href="analytics.v3.management.accounts.html">accounts</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-goals"><strong><a href="analytics.v3.management.goals.html">goals</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-profiles"><strong><a href="analytics.v3.management.profiles.html">profiles</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-segments"><strong><a href="analytics.v3.management.segments.html">segments</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-webproperties"><strong><a href="analytics.v3.management.webproperties.html">webproperties</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,78 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists profiles to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of profiles to include in this response.<br>
|
||||
webPropertyId: string, Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
accountId: string, Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"username": "A String", # Email ID of the authenticated user<br>
|
||||
"kind": "analytics#profiles", # Collection type.<br>
|
||||
"items": [ # A list of profiles.<br>
|
||||
{<br>
|
||||
"defaultPage": "A String", # Default page for this profile.<br>
|
||||
"kind": "analytics#profile", # Resource type for Analytics profile.<br>
|
||||
"excludeQueryParameters": "A String", # The query parameters that are excluded from this profile.<br>
|
||||
"name": "A String", # Name of this profile.<br>
|
||||
"created": "A String", # Time this profile was created.<br>
|
||||
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this profile belongs.<br>
|
||||
"updated": "A String", # Time this profile was last modified.<br>
|
||||
"siteSearchQueryParameters": "A String", # The site search query parameters for this profile.<br>
|
||||
"currency": "A String", # The currency type associated with this profile.<br>
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.<br>
|
||||
"childLink": { # Child link for this profile. Points to the list of goals for this profile.<br>
|
||||
"href": "A String", # Link to the list of goals for this profile.<br>
|
||||
"type": "analytics#goals", # Value is "analytics#goals".<br>
|
||||
},<br>
|
||||
"timezone": "A String", # Time zone for which this profile has been configured.<br>
|
||||
"siteSearchCategoryParameters": "A String", # Site search category parameters for this profile.<br>
|
||||
"parentLink": { # Parent link for this profile. Points to the web property to which this profile belongs.<br>
|
||||
"href": "A String", # Link to the web property to which this profile belongs.<br>
|
||||
"type": "analytics#webproperty", # Value is "analytics#webproperty".<br>
|
||||
},<br>
|
||||
"id": "A String", # Profile ID.<br>
|
||||
"selfLink": "A String", # Link for this profile.<br>
|
||||
"accountId": "A String", # Account ID to which this profile belongs.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br>
|
||||
"previousLink": "A String", # Link to previous page for this profile collection.<br>
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.<br>
|
||||
"nextLink": "A String", # Link to next page for this profile collection.<br>
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,61 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists advanced segments to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of advanced segments to include in this response.<br>
|
||||
userip: string, A parameter<br>
|
||||
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.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"username": "A String", # Email ID of the authenticated user<br>
|
||||
"kind": "analytics#segments", # Collection type for advanced segments.<br>
|
||||
"items": [ # A list of advanced segments.<br>
|
||||
{<br>
|
||||
"definition": "A String", # Advanced segment definition.<br>
|
||||
"kind": "analytics#segment", # Resource type for Analytics advanced segment.<br>
|
||||
"segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.<br>
|
||||
"created": "A String", # Time the advanced segment was created.<br>
|
||||
"updated": "A String", # Time the advanced segment was last modified.<br>
|
||||
"id": "A String", # Advanced segment ID.<br>
|
||||
"selfLink": "A String", # Link for this advanced segment.<br>
|
||||
"name": "A String", # Advanced segment name.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br>
|
||||
"previousLink": "A String", # Link to previous page for this advanced segment collection.<br>
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.<br>
|
||||
"nextLink": "A String", # Link to next page for this advanced segment collection.<br>
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,71 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists web properties to which the user has access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
max_results: integer, The maximum number of web properties to include in this response.<br>
|
||||
userip: string, A parameter<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.<br>
|
||||
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)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"username": "A String", # Email ID of the authenticated user<br>
|
||||
"kind": "analytics#webproperties", # Collection type.<br>
|
||||
"items": [ # A list of web properties.<br>
|
||||
{<br>
|
||||
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.<br>
|
||||
"name": "A String", # Name of this web property.<br>
|
||||
"created": "A String", # Time this web property was created.<br>
|
||||
"updated": "A String", # Time this web property was last modified.<br>
|
||||
"websiteUrl": "A String", # Website url for this web property.<br>
|
||||
"internalWebPropertyId": "A String", # Internal ID for this web property.<br>
|
||||
"childLink": { # Child link for this web property. Points to the list of profiles for this web property.<br>
|
||||
"href": "A String", # Link to the list of profiles for this web property.<br>
|
||||
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".<br>
|
||||
},<br>
|
||||
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.<br>
|
||||
"href": "A String", # Link to the account for this web property.<br>
|
||||
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".<br>
|
||||
},<br>
|
||||
"id": "A String", # Web property ID of the form UA-XXXXX-YY.<br>
|
||||
"selfLink": "A String", # Link for this web property.<br>
|
||||
"accountId": "A String", # Account ID to which this web property belongs.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.<br>
|
||||
"previousLink": "A String", # Link to previous page for this web property collection.<br>
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.<br>
|
||||
"nextLink": "A String", # Link to next page for this web property collection.<br>
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,40 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns Analytics report data for a profile.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
sort: string, A comma-separated list of dimensions or metrics that determine the sort order for the report data.<br>
|
||||
end_date: string, End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD. (required)<br>
|
||||
dimensions: string, A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.<br>
|
||||
ids: string, Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)<br>
|
||||
metrics: string, A comma-separated list of Analytics metrics. E.g., 'ga:visits,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. (required)<br>
|
||||
max_results: integer, The maximum number of entries to include in this feed.<br>
|
||||
filters: string, A comma-separated list of dimension or metric filters to be applied to the report data.<br>
|
||||
segment: string, An Analytics advanced segment to be applied to the report data.<br>
|
||||
start_date: string, Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD. (required)<br>
|
||||
start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
150
docs/dyn/analytics_v3.data.ga.html
Normal file
150
docs/dyn/analytics_v3.data.ga.html
Normal file
@@ -0,0 +1,150 @@
|
||||
<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 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 profile.
|
||||
|
||||
Args:
|
||||
ids: string, Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics profile ID. (required)
|
||||
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:
|
||||
|
||||
{
|
||||
"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.
|
||||
},
|
||||
"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 profile, for which the Analytics data was requested.
|
||||
"webPropertyId": "A String", # Web Property ID to which this profile belongs.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
|
||||
"tableId": "A String", # Table ID for profile.
|
||||
"profileId": "A String", # Profile ID.
|
||||
"profileName": "A String", # Profile name.
|
||||
"accountId": "A String", # Account ID to which this 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>
|
||||
82
docs/dyn/analytics_v3.data.html
Normal file
82
docs/dyn/analytics_v3.data.html
Normal file
@@ -0,0 +1,82 @@
|
||||
<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>
|
||||
|
||||
</body></html>
|
||||
87
docs/dyn/analytics_v3.html
Normal file
87
docs/dyn/analytics_v3.html
Normal file
@@ -0,0 +1,87 @@
|
||||
<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
Normal file
117
docs/dyn/analytics_v3.management.accounts.html
Normal file
@@ -0,0 +1,117 @@
|
||||
<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:
|
||||
|
||||
{
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#accounts", # Collection type.
|
||||
"items": [ # A list of accounts.
|
||||
{
|
||||
"kind": "analytics#account", # Resource type for Analytics account.
|
||||
"name": "A String", # Account name.
|
||||
"created": "A String", # Time the account was created.
|
||||
"updated": "A String", # Time the account was last modified.
|
||||
"childLink": { # Child link for an account entry. Points to the list of web properties for this account.
|
||||
"href": "A String", # Link to the list of web properties for this account.
|
||||
"type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
|
||||
},
|
||||
"id": "A String", # Account ID.
|
||||
"selfLink": "A String", # Link for this account.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Previous link for this account collection.
|
||||
"startIndex": 42, # The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Next link for this account collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
160
docs/dyn/analytics_v3.management.goals.html
Normal file
160
docs/dyn/analytics_v3.management.goals.html
Normal file
@@ -0,0 +1,160 @@
|
||||
<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, Profile ID to retrieve goals for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. (required)
|
||||
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:
|
||||
|
||||
{
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#goals", # Collection type.
|
||||
"items": [ # A list of goals.
|
||||
{
|
||||
"kind": "analytics#goal", # Resource type for an Analytics goal.
|
||||
"visitTimeOnSiteDetails": { # Details for the goal of the type VISIT_TIME_ON_SITE.
|
||||
"comparisonType": "A String", # Type of comparison. Possible values are LESS_THAN or GREATER_THAN.
|
||||
"comparisonValue": "A String", # Value used for this comparison.
|
||||
},
|
||||
"name": "A String", # Goal name.
|
||||
"created": "A String", # Time this goal was created.
|
||||
"urlDestinationDetails": { # Details for the goal of the type URL_DESTINATION.
|
||||
"url": "A String", # URL for this goal.
|
||||
"caseSensitive": True or False, # Determines if the goal URL must exactly match the capitalization of visited URLs.
|
||||
"matchType": "A String", # Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.
|
||||
"steps": [ # List of steps configured for this goal funnel.
|
||||
{
|
||||
"url": "A String", # URL for this step.
|
||||
"name": "A String", # Step name.
|
||||
"number": 42, # Step number.
|
||||
},
|
||||
],
|
||||
"firstStepRequired": True or False, # Determines if the first step in this goal is required.
|
||||
},
|
||||
"updated": "A String", # Time this goal was last modified.
|
||||
"value": 3.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", # Profile ID to which this goal belongs.
|
||||
"parentLink": { # Parent link for a goal. Points to the profile to which this goal belongs.
|
||||
"href": "A String", # Link to the profile to which this goal belongs.
|
||||
"type": "analytics#profile", # Value is "analytics#profile".
|
||||
},
|
||||
"type": "A String", # Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.
|
||||
"id": "A String", # Goal ID.
|
||||
"selfLink": "A String", # Link for this goal.
|
||||
"accountId": "A String", # Account ID to which this goal belongs.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Link to previous page for this goal collection.
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Link to next page for this goal collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
102
docs/dyn/analytics_v3.management.html
Normal file
102
docs/dyn/analytics_v3.management.html
Normal file
@@ -0,0 +1,102 @@
|
||||
<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.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>
|
||||
132
docs/dyn/analytics_v3.management.profiles.html
Normal file
132
docs/dyn/analytics_v3.management.profiles.html
Normal file
@@ -0,0 +1,132 @@
|
||||
<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 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 profiles to which the user has access.
|
||||
|
||||
Args:
|
||||
accountId: string, Account ID for the profiles to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
|
||||
webPropertyId: string, Web property ID for the profiles to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
|
||||
max_results: integer, The maximum number of 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:
|
||||
|
||||
{
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#profiles", # Collection type.
|
||||
"items": [ # A list of profiles.
|
||||
{
|
||||
"defaultPage": "A String", # Default page for this profile.
|
||||
"kind": "analytics#profile", # Resource type for Analytics profile.
|
||||
"excludeQueryParameters": "A String", # The query parameters that are excluded from this profile.
|
||||
"name": "A String", # Name of this profile.
|
||||
"created": "A String", # Time this profile was created.
|
||||
"webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this profile belongs.
|
||||
"updated": "A String", # Time this profile was last modified.
|
||||
"siteSearchQueryParameters": "A String", # The site search query parameters for this profile.
|
||||
"currency": "A String", # The currency type associated with this profile.
|
||||
"internalWebPropertyId": "A String", # Internal ID for the web property to which this profile belongs.
|
||||
"childLink": { # Child link for this profile. Points to the list of goals for this profile.
|
||||
"href": "A String", # Link to the list of goals for this profile.
|
||||
"type": "analytics#goals", # Value is "analytics#goals".
|
||||
},
|
||||
"timezone": "A String", # Time zone for which this profile has been configured.
|
||||
"siteSearchCategoryParameters": "A String", # Site search category parameters for this profile.
|
||||
"parentLink": { # Parent link for this profile. Points to the web property to which this profile belongs.
|
||||
"href": "A String", # Link to the web property to which this profile belongs.
|
||||
"type": "analytics#webproperty", # Value is "analytics#webproperty".
|
||||
},
|
||||
"id": "A String", # Profile ID.
|
||||
"selfLink": "A String", # Link for this profile.
|
||||
"accountId": "A String", # Account ID to which this profile belongs.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Link to previous page for this profile collection.
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Link to next page for this profile collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
115
docs/dyn/analytics_v3.management.segments.html
Normal file
115
docs/dyn/analytics_v3.management.segments.html
Normal file
@@ -0,0 +1,115 @@
|
||||
<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:
|
||||
|
||||
{
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#segments", # Collection type for advanced segments.
|
||||
"items": [ # A list of advanced segments.
|
||||
{
|
||||
"definition": "A String", # Advanced segment definition.
|
||||
"kind": "analytics#segment", # Resource type for Analytics advanced segment.
|
||||
"segmentId": "A String", # Segment ID. Can be used with the 'segment' parameter in Data Feed.
|
||||
"created": "A String", # Time the advanced segment was created.
|
||||
"updated": "A String", # Time the advanced segment was last modified.
|
||||
"id": "A String", # Advanced segment ID.
|
||||
"selfLink": "A String", # Link for this advanced segment.
|
||||
"name": "A String", # Advanced segment name.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Link to previous page for this advanced segment collection.
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Link to next page for this advanced segment collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
125
docs/dyn/analytics_v3.management.webproperties.html
Normal file
125
docs/dyn/analytics_v3.management.webproperties.html
Normal file
@@ -0,0 +1,125 @@
|
||||
<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:
|
||||
|
||||
{
|
||||
"username": "A String", # Email ID of the authenticated user
|
||||
"kind": "analytics#webproperties", # Collection type.
|
||||
"items": [ # A list of web properties.
|
||||
{
|
||||
"kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
|
||||
"name": "A String", # Name of this web property.
|
||||
"created": "A String", # Time this web property was created.
|
||||
"updated": "A String", # Time this web property was last modified.
|
||||
"websiteUrl": "A String", # Website url for this web property.
|
||||
"internalWebPropertyId": "A String", # Internal ID for this web property.
|
||||
"childLink": { # Child link for this web property. Points to the list of profiles for this web property.
|
||||
"href": "A String", # Link to the list of profiles for this web property.
|
||||
"type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
|
||||
},
|
||||
"parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
|
||||
"href": "A String", # Link to the account for this web property.
|
||||
"type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
|
||||
},
|
||||
"id": "A String", # Web property ID of the form UA-XXXXX-YY.
|
||||
"selfLink": "A String", # Link for this web property.
|
||||
"accountId": "A String", # Account ID to which this web property belongs.
|
||||
},
|
||||
],
|
||||
"itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
|
||||
"previousLink": "A String", # Link to previous page for this web property collection.
|
||||
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
|
||||
"nextLink": "A String", # Link to next page for this web property collection.
|
||||
"totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -1,28 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-purchases"><strong><a href="androidpublisher.v1.purchases.html">purchases</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,58 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-cancel"><strong>cancel</strong></a> = method(self, **kwargs)</dt><dd><tt>Cancels a user's subscription purchase. The subscription remains valid until its expiration time.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Checks whether a user's subscription purchase is valid and returns its expiry time.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{ # A Purchase resource indicates the status of a user's subscription purchase.<br>
|
||||
"initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since Epoch.<br>
|
||||
"kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.<br>
|
||||
"autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.<br>
|
||||
"validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since Epoch.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
82
docs/dyn/androidpublisher_v1.html
Normal file
82
docs/dyn/androidpublisher_v1.html
Normal file
@@ -0,0 +1,82 @@
|
||||
<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="androidpublisher_v1.html">Google Play Android Developer API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="androidpublisher_v1.purchases.html">purchases()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the purchases Resource.</p>
|
||||
|
||||
</body></html>
|
||||
115
docs/dyn/androidpublisher_v1.purchases.html
Normal file
115
docs/dyn/androidpublisher_v1.purchases.html
Normal file
@@ -0,0 +1,115 @@
|
||||
<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="androidpublisher_v1.html">Google Play Android Developer API</a> . <a href="androidpublisher_v1.purchases.html">purchases</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#cancel">cancel(packageName, subscriptionId, token)</a></code></p>
|
||||
<p class="firstline">Cancels a user's subscription purchase. The subscription remains valid until its expiration time.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(packageName, subscriptionId, token)</a></code></p>
|
||||
<p class="firstline">Checks whether a user's subscription purchase is valid and returns its expiry time.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="cancel">cancel(packageName, subscriptionId, token)</code>
|
||||
<pre>Cancels a user's subscription purchase. The subscription remains valid until its expiration time.
|
||||
|
||||
Args:
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(packageName, subscriptionId, token)</code>
|
||||
<pre>Checks whether a user's subscription purchase is valid and returns its expiry time.
|
||||
|
||||
Args:
|
||||
packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
|
||||
subscriptionId: string, The purchased subscription ID (for example, 'monthly001'). (required)
|
||||
token: string, The token provided to the user's device when the subscription was purchased. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{ # A Purchase resource indicates the status of a user's subscription purchase.
|
||||
"initiationTimestampMsec": "A String", # Time at which the subscription was granted, in milliseconds since Epoch.
|
||||
"kind": "androidpublisher#subscriptionPurchase", # This kind represents a subscriptionPurchase object in the androidpublisher service.
|
||||
"autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time.
|
||||
"validUntilTimestampMsec": "A String", # Time at which the subscription will expire, in milliseconds since Epoch.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -1,88 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of activities for a specific customer and application.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
caller: string, Type of the caller.<br>
|
||||
Allowed values<br>
|
||||
application_owner - Caller is an application owner.<br>
|
||||
customer - Caller is a customer.<br>
|
||||
startTime: string, Return events which occured at or after this time.<br>
|
||||
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.<br>
|
||||
applicationId: string, Application ID of the application on which the event was performed. (required)<br>
|
||||
eventName: string, Name of the event being queried.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.<br>
|
||||
strict: string, A parameter<br>
|
||||
continuationToken: string, Next page URL.<br>
|
||||
maxResults: integer, Number of activity records to be shown in each page.<br>
|
||||
parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...<br>
|
||||
actorEmail: string, Email address of the user who performed the action.<br>
|
||||
userip: string, A parameter<br>
|
||||
endTime: string, Return events which occured at or before this time.<br>
|
||||
customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # Each record in read response.<br>
|
||||
{<br>
|
||||
"kind": "audit#activity", # Kind of resource this is.<br>
|
||||
"ownerDomain": "A String", # Domain of source customer.<br>
|
||||
"actor": { # User doing the action.<br>
|
||||
"applicationId": "A String", # ID of application which interacted on behalf of the user.<br>
|
||||
"email": "A String", # Email address of the user.<br>
|
||||
"key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.<br>
|
||||
"callerType": "A String", # User or OAuth 2LO request.<br>
|
||||
},<br>
|
||||
"id": { # Unique identifier for each activity record.<br>
|
||||
"uniqQualifier": "A String", # Unique qualifier if multiple events have the same time.<br>
|
||||
"applicationId": "A String", # Application ID of the source application.<br>
|
||||
"customerId": "A String", # Obfuscated customer ID of the source customer.<br>
|
||||
"time": "A String", # Time of occurrence of the activity.<br>
|
||||
},<br>
|
||||
"ipAddress": "A String", # IP Address of the user doing the action.<br>
|
||||
"events": [ # Activity events.<br>
|
||||
{<br>
|
||||
"eventType": "A String", # Type of event.<br>
|
||||
"name": "A String", # Name of event.<br>
|
||||
"parameters": [ # Event parameters.<br>
|
||||
{<br>
|
||||
"name": "A String", # Name of the parameter.<br>
|
||||
"value": "A String", # Value of the parameter.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "audit#activities", # Kind of list response this is.<br>
|
||||
"next": "A String", # Next page URL.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,28 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-activities"><strong><a href="audit.v1.activities.html">activities</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
142
docs/dyn/audit_v1.activities.html
Normal file
142
docs/dyn/audit_v1.activities.html
Normal file
@@ -0,0 +1,142 @@
|
||||
<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="audit_v1.html">Enterprise Audit API</a> . <a href="audit_v1.activities.html">activities</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, parameters=None, actorEmail=None, endTime=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of activities for a specific customer and application.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(customerId, applicationId, caller=None, startTime=None, actorIpAddress=None, eventName=None, actorApplicationId=None, continuationToken=None, maxResults=None, parameters=None, actorEmail=None, endTime=None)</code>
|
||||
<pre>Retrieves a list of activities for a specific customer and application.
|
||||
|
||||
Args:
|
||||
customerId: string, Represents the customer who is the owner of target object on which action was performed. (required)
|
||||
applicationId: string, Application ID of the application on which the event was performed. (required)
|
||||
caller: string, Type of the caller.
|
||||
Allowed values
|
||||
application_owner - Caller is an application owner.
|
||||
customer - Caller is a customer.
|
||||
startTime: string, Return events which occured at or after this time.
|
||||
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
|
||||
eventName: string, Name of the event being queried.
|
||||
actorApplicationId: string, Application ID of the application which interacted on behalf of the user while performing the event.
|
||||
continuationToken: string, Next page URL.
|
||||
maxResults: integer, Number of activity records to be shown in each page.
|
||||
parameters: string, Event parameters in the form [parameter1 name]:[parameter1 value],[parameter2 name]:[parameter2 value],...
|
||||
actorEmail: string, Email address of the user who performed the action.
|
||||
endTime: string, Return events which occured at or before this time.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [ # Each record in read response.
|
||||
{
|
||||
"kind": "audit#activity", # Kind of resource this is.
|
||||
"ownerDomain": "A String", # Domain of source customer.
|
||||
"actor": { # User doing the action.
|
||||
"applicationId": "A String", # ID of application which interacted on behalf of the user.
|
||||
"email": "A String", # Email address of the user.
|
||||
"key": "A String", # For OAuth 2LO API requests, consumer_key of the requestor.
|
||||
"callerType": "A String", # User or OAuth 2LO request.
|
||||
},
|
||||
"id": { # Unique identifier for each activity record.
|
||||
"uniqQualifier": "A String", # Unique qualifier if multiple events have the same time.
|
||||
"applicationId": "A String", # Application ID of the source application.
|
||||
"customerId": "A String", # Obfuscated customer ID of the source customer.
|
||||
"time": "A String", # Time of occurrence of the activity.
|
||||
},
|
||||
"ipAddress": "A String", # IP Address of the user doing the action.
|
||||
"events": [ # Activity events.
|
||||
{
|
||||
"eventType": "A String", # Type of event.
|
||||
"name": "A String", # Name of event.
|
||||
"parameters": [ # Event parameters.
|
||||
{
|
||||
"name": "A String", # Name of the parameter.
|
||||
"value": "A String", # Value of the parameter.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"kind": "audit#activities", # Kind of list response this is.
|
||||
"next": "A String", # Next page URL.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
82
docs/dyn/audit_v1.html
Normal file
82
docs/dyn/audit_v1.html
Normal file
@@ -0,0 +1,82 @@
|
||||
<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="audit_v1.html">Enterprise Audit API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="audit_v1.activities.html">activities()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the activities Resource.</p>
|
||||
|
||||
</body></html>
|
||||
@@ -1,334 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
deleteContents: boolean, If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
projectId: string, Project ID of the dataset being deleted (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of dataset being deleted (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the dataset specified by datasetID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the requested dataset (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the requested dataset (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates a new empty dataset.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the new dataset (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
maxResults: integer, The maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
projectId: string, Project ID of the datasets to be listed (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # A token to request the next page of results. Present only when there is more than one page of results.* See Paging Through Results in the developer's guide.<br>
|
||||
"kind": "bigquery#datasetList", # The type of list.<br>
|
||||
"datasets": [ # An array of one or more summarized dataset resources. Absent when there are no datasets in the specified project.<br>
|
||||
{<br>
|
||||
"friendlyName": "A String", # A descriptive name for this dataset, if one exists.<br>
|
||||
"kind": "bigquery#dataset", # The resource type.<br>
|
||||
"id": "A String", # The fully-qualified unique name of this dataset in the format projectId:datasetId.<br>
|
||||
"datasetReference": { # Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # A hash of this page of results. See Paging Through Results in the developer's guide.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the dataset being updated (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the dataset being updated (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the dataset being updated (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the dataset being updated (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.<br>
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.<br>
|
||||
"datasetReference": { # [Required] Reference identifying dataset.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.<br>
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.<br>
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers<br>
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.<br>
|
||||
# To revoke rights to a dataset, call datasets.<a href="#Resource-update">update</a>() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.<br>
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.<br>
|
||||
{<br>
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.<br>
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".<br>
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any <a href="#Resource-list">list</a>() or <a href="#Resource-get">get</a>() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call <a href="#Resource-list">list</a>() and <a href="#Resource-get">get</a>(). OWNER - User can call any method. The dataset creator is granted this role by default.<br>
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.<br>
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.<br>
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.<br>
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,36 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-datasets"><strong><a href="bigquery.v2.datasets.html">datasets</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-jobs"><strong><a href="bigquery.v2.jobs.html">jobs</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-projects"><strong><a href="bigquery.v2.projects.html">projects</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-tabledata"><strong><a href="bigquery.v2.tabledata.html">tabledata</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-tables"><strong><a href="bigquery.v2.tables.html">tables</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,671 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the specified job by ID.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the requested job (required)<br>
|
||||
jobId: string, Job ID of the requested job (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.<br>
|
||||
"state": "A String", # [Output-only] Running state of the job.<br>
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br>
|
||||
{<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"kind": "bigquery#job", # [Output-only] The type of the resource.<br>
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br>
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br>
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br>
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br>
|
||||
},<br>
|
||||
"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.<br>
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.<br>
|
||||
"jobId": "A String", # [Required] ID of the job.<br>
|
||||
},<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"configuration": { # [Required] Describes the job configuration.<br>
|
||||
"load": { # [Pick one] Configures a load job.<br>
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br>
|
||||
"destinationTable": { # [Required] Table being written to.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"schema": { # [Optional] Schema of the table being written to.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br>
|
||||
"destinationTable": { # [Required] The destination table<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceTable": { # [Required] Source table to copy.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-getQueryResults"><strong>getQueryResults</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the results of a query job.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the query job (required)<br>
|
||||
maxResults: integer, Maximum number of results to read<br>
|
||||
jobId: string, Job ID of the query job (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
startIndex: string, Zero-based index of the starting row<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#getQueryResultsResponse", # The resource type of the response.<br>
|
||||
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.<br>
|
||||
{<br>
|
||||
"f": [ # Represents a single row in the result set, consisting of one or more fields.<br>
|
||||
{<br>
|
||||
"v": "A String", # Contains the field value in this row, as a string.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"jobReference": { # Reference to the Helix Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).<br>
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.<br>
|
||||
"jobId": "A String", # [Required] ID of the job.<br>
|
||||
},<br>
|
||||
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.<br>
|
||||
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.<br>
|
||||
"etag": "A String", # A hash of this response.<br>
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Starts a new asynchronous job.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body.<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.<br>
|
||||
"state": "A String", # [Output-only] Running state of the job.<br>
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br>
|
||||
{<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"kind": "bigquery#job", # [Output-only] The type of the resource.<br>
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br>
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br>
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br>
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br>
|
||||
},<br>
|
||||
"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.<br>
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.<br>
|
||||
"jobId": "A String", # [Required] ID of the job.<br>
|
||||
},<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"configuration": { # [Required] Describes the job configuration.<br>
|
||||
"load": { # [Pick one] Configures a load job.<br>
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br>
|
||||
"destinationTable": { # [Required] Table being written to.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"schema": { # [Optional] Schema of the table being written to.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br>
|
||||
"destinationTable": { # [Required] The destination table<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceTable": { # [Required] Source table to copy.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
}<br>
|
||||
<br>
|
||||
media_body: string, The filename of the media request body.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the project that will be billed for the job (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.<br>
|
||||
"state": "A String", # [Output-only] Running state of the job.<br>
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br>
|
||||
{<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"kind": "bigquery#job", # [Output-only] The type of the resource.<br>
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br>
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br>
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br>
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br>
|
||||
},<br>
|
||||
"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.<br>
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.<br>
|
||||
"jobId": "A String", # [Required] ID of the job.<br>
|
||||
},<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"configuration": { # [Required] Describes the job configuration.<br>
|
||||
"load": { # [Pick one] Configures a load job.<br>
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br>
|
||||
"destinationTable": { # [Required] Table being written to.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"schema": { # [Optional] Schema of the table being written to.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br>
|
||||
"destinationTable": { # [Required] The destination table<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceTable": { # [Required] Source table to copy.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all the Jobs in the specified project that were started by the user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
projection: string, Restrict information returned to a set of selected fields<br>
|
||||
Allowed values<br>
|
||||
full - Includes all job data<br>
|
||||
minimal - Does not include the job configuration<br>
|
||||
stateFilter: string, Filter for job state (repeated)<br>
|
||||
Allowed values<br>
|
||||
done - Finished jobs<br>
|
||||
pending - Pending jobs<br>
|
||||
running - Running jobs<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
projectId: string, Project ID of the jobs to list (required)<br>
|
||||
allUsers: boolean, Whether to display jobs owned by all users in the project. Default false<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # A token to request the next page of results.<br>
|
||||
"totalItems": 42, # Total number of jobs in this collection.<br>
|
||||
"kind": "bigquery#jobList", # The resource type of the response.<br>
|
||||
"etag": "A String", # A hash of this page of results.<br>
|
||||
"jobs": [ # List of jobs that were requested.<br>
|
||||
{<br>
|
||||
"status": { # [Full-projection-only] Describes the state of the job.<br>
|
||||
"state": "A String", # [Output-only] Running state of the job.<br>
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.<br>
|
||||
{<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"kind": "bigquery#job", # The resource type.<br>
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.<br>
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.<br>
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.<br>
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.<br>
|
||||
},<br>
|
||||
"jobReference": { # Job reference uniquely identifying the job.<br>
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.<br>
|
||||
"jobId": "A String", # [Required] ID of the job.<br>
|
||||
},<br>
|
||||
"state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.<br>
|
||||
"configuration": { # [Full-projection-only] Specifies the job configuration.<br>
|
||||
"load": { # [Pick one] Configures a load job.<br>
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','<br>
|
||||
"destinationTable": { # [Required] Table being written to.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"schema": { # [Optional] Schema of the table being written to.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"link": { # [Pick one] Configures a link job.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.<br>
|
||||
"destinationTable": { # [Required] The destination table of the link job.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceUri": [ # [Required] URI of source table to link.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
},<br>
|
||||
"query": { # [Pick one] Configures a query job.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.<br>
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.<br>
|
||||
},<br>
|
||||
"copy": { # [Pick one] Copies a table.<br>
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.<br>
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.<br>
|
||||
"destinationTable": { # [Required] The destination table<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"sourceTable": { # [Required] Source table to copy.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"extract": { # [Pick one] Configures an extract job.<br>
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.<br>
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','<br>
|
||||
"sourceTable": { # [Required] A reference to the table being exported.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.<br>
|
||||
},<br>
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
"id": "A String", # Unique opaque ID of the job.<br>
|
||||
"errorResult": { # A result object that will be present only if the job has failed.<br>
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.<br>
|
||||
"message": "A String", # A human readable explanation of the error.<br>
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.<br>
|
||||
"location": "A String", # Specifies where the error occurred, if present.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
],<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-query"><strong>query</strong></a> = method(self, **kwargs)</dt><dd><tt>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.<br>
|
||||
"query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.<br>
|
||||
"kind": "bigquery#queryRequest", # The resource type of the request.<br>
|
||||
"maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.<br>
|
||||
"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.<br>
|
||||
"projectId": "A String", # [Optional] The ID of the container project.<br>
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the project billed for the query (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#queryResponse", # The resource type.<br>
|
||||
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.<br>
|
||||
{<br>
|
||||
"f": [ # Represents a single row in the result set, consisting of one or more fields.<br>
|
||||
{<br>
|
||||
"v": "A String", # Contains the field value in this row, as a string.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"jobReference": { # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).<br>
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.<br>
|
||||
"jobId": "A String", # [Required] ID of the job.<br>
|
||||
},<br>
|
||||
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.<br>
|
||||
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.<br>
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,66 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists the projects to which you have at least read access.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # A token to request the next page of results.<br>
|
||||
"totalItems": 42, # The total number of projects in the list.<br>
|
||||
"kind": "bigquery#projectList", # The type of list.<br>
|
||||
"etag": "A String", # A hash of the page of results<br>
|
||||
"projects": [ # Projects to which you have at least READ access.<br>
|
||||
{<br>
|
||||
"friendlyName": "A String", # A descriptive name for this project.<br>
|
||||
"kind": "bigquery#project", # The resource type.<br>
|
||||
"id": "A String", # An opaque ID of this project.<br>
|
||||
"projectReference": { # A unique reference to this project.<br>
|
||||
"projectId": "A String", # [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
],<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,57 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves table data from a specified set of rows.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to read (required)<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
startIndex: string, Zero-based index of the starting row to read<br>
|
||||
tableId: string, Table ID of the table to read (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to read (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"rows": [ # Rows of results.<br>
|
||||
{<br>
|
||||
"f": [ # Represents a single row in the result set, consisting of one or more fields.<br>
|
||||
{<br>
|
||||
"v": "A String", # Contains the field value in this row, as a string.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "bigquery#tableDataList", # The resource type of the response.<br>
|
||||
"etag": "A String", # A hash of this page of results.<br>
|
||||
"totalRows": "A String", # The total number of rows in the complete table.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,362 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to delete (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the table to delete (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to delete (required)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the requested table (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the requested table (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the requested table (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates a new, empty table in the dataset.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the new table (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the new table (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists all tables in the specified dataset.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results<br>
|
||||
maxResults: integer, Maximum number of results to return<br>
|
||||
strict: string, A parameter<br>
|
||||
projectId: string, Project ID of the tables to list (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the tables to list (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # A token to request the next page of results.<br>
|
||||
"tables": [ # Tables in the requested dataset.<br>
|
||||
{<br>
|
||||
"friendlyName": "A String", # The user-friendly name for this table.<br>
|
||||
"kind": "bigquery#table", # The resource type.<br>
|
||||
"id": "A String", # An opaque ID of the table<br>
|
||||
"tableReference": { # A reference uniquely identifying the table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "bigquery#tableList", # The type of list.<br>
|
||||
"etag": "A String", # A hash of this page of results.<br>
|
||||
"totalItems": 42, # The total number of tables in the dataset.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates information in an existing table, specified by tableId. This method supports patch semantics.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to update (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the table to update (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to update (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates information in an existing table, specified by tableId.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
body: object, The request body. (required)<br>
|
||||
The object takes the form of:<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}<br>
|
||||
<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
projectId: string, Project ID of the table to update (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
tableId: string, Table ID of the table to update (required)<br>
|
||||
userip: string, A parameter<br>
|
||||
datasetId: string, Dataset ID of the table to update (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.<br>
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.<br>
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.<br>
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.<br>
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.<br>
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.<br>
|
||||
"tableId": "A String", # [Required] ID of the table.<br>
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.<br>
|
||||
},<br>
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.<br>
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.<br>
|
||||
"etag": "A String", # [Output-only] A hash of this resource.<br>
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.<br>
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.<br>
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.<br>
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.<br>
|
||||
"schema": { # [Optional] Describes the schema of this table.<br>
|
||||
"fields": [ # Describes the fields in a table.<br>
|
||||
{<br>
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.<br>
|
||||
# Object with schema name: TableFieldSchema<br>
|
||||
],<br>
|
||||
"type": "A String", # [Required] Data type of the field.<br>
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.<br>
|
||||
"name": "A String", # [Required] Name of the field.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
},<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
406
docs/dyn/bigquery_v2.datasets.html
Normal file
406
docs/dyn/bigquery_v2.datasets.html
Normal file
@@ -0,0 +1,406 @@
|
||||
<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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.datasets.html">datasets</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(projectId, datasetId, deleteContents=None)</a></code></p>
|
||||
<p class="firstline">Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(projectId, datasetId)</a></code></p>
|
||||
<p class="firstline">Returns the dataset specified by datasetID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(projectId, body)</a></code></p>
|
||||
<p class="firstline">Creates a new empty dataset.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(projectId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.</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(projectId, datasetId, body)</a></code></p>
|
||||
<p class="firstline">Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(projectId, datasetId, body)</a></code></p>
|
||||
<p class="firstline">Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(projectId, datasetId, deleteContents=None)</code>
|
||||
<pre>Deletes the dataset specified by datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the dataset being deleted (required)
|
||||
datasetId: string, Dataset ID of dataset being deleted (required)
|
||||
deleteContents: boolean, If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(projectId, datasetId)</code>
|
||||
<pre>Returns the dataset specified by datasetID.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the requested dataset (required)
|
||||
datasetId: string, Dataset ID of the requested dataset (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(projectId, body)</code>
|
||||
<pre>Creates a new empty dataset.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the new dataset (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(projectId, pageToken=None, maxResults=None)</code>
|
||||
<pre>Lists all the datasets in the specified project to which the caller has read access; however, a project owner can list (but not necessarily get) all datasets in his project.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the datasets to be listed (required)
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results
|
||||
maxResults: integer, The maximum number of results to return
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token to request the next page of results. Present only when there is more than one page of results.* See Paging Through Results in the developer's guide.
|
||||
"kind": "bigquery#datasetList", # The type of list.
|
||||
"datasets": [ # An array of one or more summarized dataset resources. Absent when there are no datasets in the specified project.
|
||||
{
|
||||
"friendlyName": "A String", # A descriptive name for this dataset, if one exists.
|
||||
"kind": "bigquery#dataset", # The resource type.
|
||||
"id": "A String", # The fully-qualified unique name of this dataset in the format projectId:datasetId.
|
||||
"datasetReference": { # Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
},
|
||||
],
|
||||
"etag": "A String", # A hash of this page of results. See Paging Through Results in the developer's guide.
|
||||
}</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(projectId, datasetId, body)</code>
|
||||
<pre>Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the dataset being updated (required)
|
||||
datasetId: string, Dataset ID of the dataset being updated (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(projectId, datasetId, body)</code>
|
||||
<pre>Updates information in an existing dataset, specified by datasetId. Properties not included in the submitted resource will not be changed. If you include the access property without any values assigned, the request will fail as you must specify at least one owner for a dataset.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the dataset being updated (required)
|
||||
datasetId: string, Dataset ID of the dataset being updated (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#dataset", # [Output-only] The resource type.
|
||||
"description": "A String", # [Optional] A user-friendly string description for the dataset. This might be shown in BigQuery UI for browsing the dataset.
|
||||
"datasetReference": { # [Required] Reference identifying dataset.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"creationTime": "A String", # [Output-only] The time when this dataset was created, in milliseconds since the epoch.
|
||||
"access": [ # [Optional] Describes users' rights on the dataset. You can assign the same role to multiple users, and assign multiple roles to the same user.
|
||||
# Default values assigned to a new dataset are as follows: OWNER - Project owners, dataset creator READ - Project readers WRITE - Project writers
|
||||
# See ACLs and Rights for a description of these rights. If you specify any of these roles when creating a dataset, the assigned roles will overwrite the defaults listed above.
|
||||
# To revoke rights to a dataset, call datasets.update() and omit the names of anyone whose rights you wish to revoke. However, every dataset must have at least one entity granted OWNER role.
|
||||
# Each access object can have only one of the following members: userByEmail, groupByEmail, domain, or allAuthenticatedUsers.
|
||||
{
|
||||
"specialGroup": "A String", # [Pick one] A special group to grant access to. The valid values are: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users.
|
||||
"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com".
|
||||
"role": "A String", # [Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READ - User can call any list() or get() method on any collection or resource. WRITE - User can call any method on any collection except for datasets, on which they can call list() and get(). OWNER - User can call any method. The dataset creator is granted this role by default.
|
||||
"groupByEmail": "A String", # [Pick one] A fully-qualified email address of a mailing list to grant access to. This must be either a Google Groups mailing list (ends in @googlegroups.com) or a group managed by an enterprise version of Google Groups.
|
||||
"userByEmail": "A String", # [Pick one] A fully qualified email address of a user to grant access to. For example: fred@example.com.
|
||||
},
|
||||
],
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this dataset, which might be shown in any BigQuery user interfaces for browsing the dataset. Use datasetId for making API calls.
|
||||
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
|
||||
"id": "A String", # [Output-only] The fully-qualified unique name of this dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
|
||||
"selfLink": "A String", # [Output-only] An URL that can be used to access this resource again. You can use this URL in Get or Update requests to this resource.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
102
docs/dyn/bigquery_v2.html
Normal file
102
docs/dyn/bigquery_v2.html
Normal file
@@ -0,0 +1,102 @@
|
||||
<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="bigquery_v2.html">BigQuery API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="bigquery_v2.datasets.html">datasets()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the datasets Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="bigquery_v2.jobs.html">jobs()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the jobs Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="bigquery_v2.projects.html">projects()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the projects Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="bigquery_v2.tabledata.html">tabledata()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the tabledata Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="bigquery_v2.tables.html">tables()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the tables Resource.</p>
|
||||
|
||||
</body></html>
|
||||
748
docs/dyn/bigquery_v2.jobs.html
Normal file
748
docs/dyn/bigquery_v2.jobs.html
Normal file
@@ -0,0 +1,748 @@
|
||||
<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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.jobs.html">jobs</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(projectId, jobId)</a></code></p>
|
||||
<p class="firstline">Retrieves the specified job by ID.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, maxResults=None, startIndex=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the results of a query job.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(projectId, body=None, media_body=None)</a></code></p>
|
||||
<p class="firstline">Starts a new asynchronous job.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Lists all the Jobs in the specified project that were started by the user.</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="#query">query(projectId, body)</a></code></p>
|
||||
<p class="firstline">Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(projectId, jobId)</code>
|
||||
<pre>Retrieves the specified job by ID.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the requested job (required)
|
||||
jobId: string, Job ID of the requested job (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
"kind": "bigquery#job", # [Output-only] The type of the resource.
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
|
||||
},
|
||||
"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"configuration": { # [Required] Describes the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"A String",
|
||||
],
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"destinationTable": { # [Required] The destination table of the link job.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceUri": [ # [Required] URI of source table to link.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
|
||||
"destinationTable": { # [Required] The destination table
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceTable": { # [Required] Source table to copy.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
},
|
||||
"extract": { # [Pick one] Configures an extract job.
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
"sourceTable": { # [Required] A reference to the table being exported.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getQueryResults">getQueryResults(projectId, jobId, timeoutMs=None, maxResults=None, startIndex=None)</code>
|
||||
<pre>Retrieves the results of a query job.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the query job (required)
|
||||
jobId: string, Job ID of the query job (required)
|
||||
timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error
|
||||
maxResults: integer, Maximum number of results to read
|
||||
startIndex: string, Zero-based index of the starting row
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#getQueryResultsResponse", # The resource type of the response.
|
||||
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
|
||||
{
|
||||
"f": [ # Represents a single row in the result set, consisting of one or more fields.
|
||||
{
|
||||
"v": "A String", # Contains the field value in this row, as a string.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"jobReference": { # Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
|
||||
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
|
||||
"etag": "A String", # A hash of this response.
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(projectId, body=None, media_body=None)</code>
|
||||
<pre>Starts a new asynchronous job.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the project that will be billed for the job (required)
|
||||
body: object, The request body.
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
"kind": "bigquery#job", # [Output-only] The type of the resource.
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
|
||||
},
|
||||
"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"configuration": { # [Required] Describes the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"A String",
|
||||
],
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"destinationTable": { # [Required] The destination table of the link job.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceUri": [ # [Required] URI of source table to link.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
|
||||
"destinationTable": { # [Required] The destination table
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceTable": { # [Required] Source table to copy.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
},
|
||||
"extract": { # [Pick one] Configures an extract job.
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
"sourceTable": { # [Required] A reference to the table being exported.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
}
|
||||
|
||||
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
"kind": "bigquery#job", # [Output-only] The type of the resource.
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
|
||||
},
|
||||
"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"configuration": { # [Required] Describes the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"A String",
|
||||
],
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"destinationTable": { # [Required] The destination table of the link job.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceUri": [ # [Required] URI of source table to link.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
|
||||
"destinationTable": { # [Required] The destination table
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceTable": { # [Required] Source table to copy.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
},
|
||||
"extract": { # [Pick one] Configures an extract job.
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
"sourceTable": { # [Required] A reference to the table being exported.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # [Output-only] Opaque ID field of the job
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(projectId, projection=None, stateFilter=None, pageToken=None, allUsers=None, maxResults=None)</code>
|
||||
<pre>Lists all the Jobs in the specified project that were started by the user.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the jobs to list (required)
|
||||
projection: string, Restrict information returned to a set of selected fields
|
||||
Allowed values
|
||||
full - Includes all job data
|
||||
minimal - Does not include the job configuration
|
||||
stateFilter: string, Filter for job state (repeated)
|
||||
Allowed values
|
||||
done - Finished jobs
|
||||
pending - Pending jobs
|
||||
running - Running jobs
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results
|
||||
allUsers: boolean, Whether to display jobs owned by all users in the project. Default false
|
||||
maxResults: integer, Maximum number of results to return
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token to request the next page of results.
|
||||
"totalItems": 42, # Total number of jobs in this collection.
|
||||
"kind": "bigquery#jobList", # The resource type of the response.
|
||||
"etag": "A String", # A hash of this page of results.
|
||||
"jobs": [ # List of jobs that were requested.
|
||||
{
|
||||
"status": { # [Full-projection-only] Describes the state of the job.
|
||||
"state": "A String", # [Output-only] Running state of the job.
|
||||
"errors": [ # [Output-only] All errors encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.
|
||||
{
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
],
|
||||
"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
"kind": "bigquery#job", # The resource type.
|
||||
"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.
|
||||
"endTime": "A String", # [Output-only] End time of this job, in milliseconds since the epoch.
|
||||
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for this job.
|
||||
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch.
|
||||
},
|
||||
"jobReference": { # Job reference uniquely identifying the job.
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
|
||||
"configuration": { # [Full-projection-only] Specifies the job configuration.
|
||||
"load": { # [Pick one] Configures a load job.
|
||||
"encoding": "A String", # [Optional] Character encoding of the input data. May be UTF-8 or ISO-8859-1. Default is UTF-8.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the import data. Default is ','
|
||||
"destinationTable": { # [Required] Table being written to.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"maxBadRecords": 42, # [Optional] Maximum number of bad records that should be ignored before the entire job is aborted and no updates are performed.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"sourceUris": [ # [Required] Source URIs describing Google Cloud Storage locations of data to load.
|
||||
"A String",
|
||||
],
|
||||
"skipLeadingRows": 42, # [Optional] Number of rows of initial data to skip in the data being imported.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"schemaInlineFormat": "A String", # [Experimental] Format of inlineSchema field.
|
||||
"schemaInline": "A String", # [Experimental] Inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT"
|
||||
"schema": { # [Optional] Schema of the table being written to.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
"link": { # [Pick one] Configures a link job.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_APPEND.
|
||||
"destinationTable": { # [Required] The destination table of the link job.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceUri": [ # [Required] URI of source table to link.
|
||||
"A String",
|
||||
],
|
||||
},
|
||||
"query": { # [Pick one] Configures a query job.
|
||||
"defaultDataset": { # [Optional] Specifies the default dataset to assume for unqualified table names in the query.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
"destinationTable": { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"priority": "A String", # [Experimental] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH, which may be subject to looser quota restrictions.
|
||||
"writeDisposition": "A String", # [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY.
|
||||
"createDisposition": "A String", # [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED.
|
||||
"query": "A String", # [Required] BigQuery SQL query to execute.
|
||||
},
|
||||
"copy": { # [Pick one] Copies a table.
|
||||
"createDisposition": "A String", # [Optional] Whether or not to create a new table, if none exists.
|
||||
"writeDisposition": "A String", # [Optional] Whether or not to append or require the table to be empty.
|
||||
"destinationTable": { # [Required] The destination table
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"sourceTable": { # [Required] Source table to copy.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
},
|
||||
"extract": { # [Pick one] Configures an extract job.
|
||||
"destinationUri": "A String", # [Required] The fully-qualified Google Cloud Storage URI where the extracted table should be written.
|
||||
"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','
|
||||
"sourceTable": { # [Required] A reference to the table being exported.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"printHeader": True or False, # [Optional] Whether to print out a heder row in the results. Default is true.
|
||||
},
|
||||
"properties": { # [Optional] Properties providing extra details about how the job should be run. Not used for most jobs.
|
||||
},
|
||||
},
|
||||
"id": "A String", # Unique opaque ID of the job.
|
||||
"errorResult": { # A result object that will be present only if the job has failed.
|
||||
"debugInfo": "A String", # Debugging information for the service, if present. Should be ignored.
|
||||
"message": "A String", # A human readable explanation of the error.
|
||||
"reason": "A String", # Specifies the error reason. For example, reason will be "required" or "invalid" if some field was missing or malformed.
|
||||
"location": "A String", # Specifies where the error occurred, if present.
|
||||
},
|
||||
},
|
||||
],
|
||||
}</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="query">query(projectId, body)</code>
|
||||
<pre>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the project billed for the query (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before returning. Default is to return immediately. If the timeout passes before the job completes, the request will fail with a TIMEOUT error.
|
||||
"query": "A String", # [Required] A query string, following the BigQuery query syntax of the query to execute. Table names should be qualified by dataset name in the format projectId:datasetId.tableId unless you specify the defaultDataset value. If the table is in the same project as the job, you can omit the project ID. Example: SELECT f1 FROM myProjectId:myDatasetId.myTableId.
|
||||
"kind": "bigquery#queryRequest", # The resource type of the request.
|
||||
"maxResults": 42, # [Optional] The maximum number of results to return per page of results. If the response list exceeds the maximum response size for a single response, you will have to page through the results. Default is to return the maximum response size.
|
||||
"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be fully-qualified in the format projectId:datasetId.tableid.
|
||||
"projectId": "A String", # [Optional] The ID of the container project.
|
||||
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name.
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#queryResponse", # The resource type.
|
||||
"rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
|
||||
{
|
||||
"f": [ # Represents a single row in the result set, consisting of one or more fields.
|
||||
{
|
||||
"v": "A String", # Contains the field value in this row, as a string.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"jobReference": { # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
|
||||
"projectId": "A String", # [Required] Project ID being billed for the job.
|
||||
"jobId": "A String", # [Required] ID of the job.
|
||||
},
|
||||
"jobComplete": True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
|
||||
"totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
|
||||
"schema": { # The schema of the results. Present only when the query completes successfully.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
127
docs/dyn/bigquery_v2.projects.html
Normal file
127
docs/dyn/bigquery_v2.projects.html
Normal file
@@ -0,0 +1,127 @@
|
||||
<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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.projects.html">projects</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">Lists the projects to which you have at least read access.</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>Lists the projects to which you have at least read access.
|
||||
|
||||
Args:
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results
|
||||
maxResults: integer, Maximum number of results to return
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token to request the next page of results.
|
||||
"totalItems": 42, # The total number of projects in the list.
|
||||
"kind": "bigquery#projectList", # The type of list.
|
||||
"etag": "A String", # A hash of the page of results
|
||||
"projects": [ # Projects to which you have at least READ access.
|
||||
{
|
||||
"friendlyName": "A String", # A descriptive name for this project.
|
||||
"kind": "bigquery#project", # The resource type.
|
||||
"id": "A String", # An opaque ID of this project.
|
||||
"projectReference": { # A unique reference to this project.
|
||||
"projectId": "A String", # [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.
|
||||
},
|
||||
},
|
||||
],
|
||||
}</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>
|
||||
113
docs/dyn/bigquery_v2.tabledata.html
Normal file
113
docs/dyn/bigquery_v2.tabledata.html
Normal file
@@ -0,0 +1,113 @@
|
||||
<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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.tabledata.html">tabledata</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
|
||||
<p class="firstline">Retrieves table data from a specified set of rows.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</code>
|
||||
<pre>Retrieves table data from a specified set of rows.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the table to read (required)
|
||||
datasetId: string, Dataset ID of the table to read (required)
|
||||
tableId: string, Table ID of the table to read (required)
|
||||
pageToken: string, Page token, returned by a previous call, identifying the result set
|
||||
maxResults: integer, Maximum number of results to return
|
||||
startIndex: string, Zero-based index of the starting row to read
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"pageToken": "A String", # A token used for paging results. Providing this token instead of the startRow parameter can help you retrieve stable results when an underlying table is changing.
|
||||
"kind": "bigquery#tableDataList", # The resource type of the response.
|
||||
"etag": "A String", # A hash of this page of results.
|
||||
"rows": [ # Rows of results.
|
||||
{
|
||||
"f": [ # Represents a single row in the result set, consisting of one or more fields.
|
||||
{
|
||||
"v": "A String", # Contains the field value in this row, as a string.
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"totalRows": "A String", # The total number of rows in the complete table.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
434
docs/dyn/bigquery_v2.tables.html
Normal file
434
docs/dyn/bigquery_v2.tables.html
Normal file
@@ -0,0 +1,434 @@
|
||||
<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="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.tables.html">tables</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(projectId, datasetId, tableId)</a></code></p>
|
||||
<p class="firstline">Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(projectId, datasetId, tableId)</a></code></p>
|
||||
<p class="firstline">Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(projectId, datasetId, body)</a></code></p>
|
||||
<p class="firstline">Creates a new, empty table in the dataset.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(projectId, datasetId, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Lists all tables in the specified dataset.</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(projectId, datasetId, tableId, body)</a></code></p>
|
||||
<p class="firstline">Updates information in an existing table, specified by tableId. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(projectId, datasetId, tableId, body)</a></code></p>
|
||||
<p class="firstline">Updates information in an existing table, specified by tableId.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(projectId, datasetId, tableId)</code>
|
||||
<pre>Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the table to delete (required)
|
||||
datasetId: string, Dataset ID of the table to delete (required)
|
||||
tableId: string, Table ID of the table to delete (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(projectId, datasetId, tableId)</code>
|
||||
<pre>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the requested table (required)
|
||||
datasetId: string, Dataset ID of the requested table (required)
|
||||
tableId: string, Table ID of the requested table (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(projectId, datasetId, body)</code>
|
||||
<pre>Creates a new, empty table in the dataset.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the new table (required)
|
||||
datasetId: string, Dataset ID of the new table (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(projectId, datasetId, pageToken=None, maxResults=None)</code>
|
||||
<pre>Lists all tables in the specified dataset.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the tables to list (required)
|
||||
datasetId: string, Dataset ID of the tables to list (required)
|
||||
pageToken: string, Page token, returned by a previous call, to request the next page of results
|
||||
maxResults: integer, Maximum number of results to return
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # A token to request the next page of results.
|
||||
"tables": [ # Tables in the requested dataset.
|
||||
{
|
||||
"friendlyName": "A String", # The user-friendly name for this table.
|
||||
"kind": "bigquery#table", # The resource type.
|
||||
"id": "A String", # An opaque ID of the table
|
||||
"tableReference": { # A reference uniquely identifying the table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
},
|
||||
],
|
||||
"kind": "bigquery#tableList", # The type of list.
|
||||
"etag": "A String", # A hash of this page of results.
|
||||
"totalItems": 42, # The total number of tables in the dataset.
|
||||
}</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(projectId, datasetId, tableId, body)</code>
|
||||
<pre>Updates information in an existing table, specified by tableId. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the table to update (required)
|
||||
datasetId: string, Dataset ID of the table to update (required)
|
||||
tableId: string, Table ID of the table to update (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(projectId, datasetId, tableId, body)</code>
|
||||
<pre>Updates information in an existing table, specified by tableId.
|
||||
|
||||
Args:
|
||||
projectId: string, Project ID of the table to update (required)
|
||||
datasetId: string, Dataset ID of the table to update (required)
|
||||
tableId: string, Table ID of the table to update (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "bigquery#table", # [Output-only] The type of the resource.
|
||||
"lastModifiedTime": "A String", # [Output-only] The time when this table was last modified, in milliseconds since the epoch.
|
||||
"description": "A String", # [Optional] A user-friendly description of this table.
|
||||
"creationTime": "A String", # [Output-only] The time when this table was created, in milliseconds since the epoch.
|
||||
"tableReference": { # [Required] Reference describing the ID of this table.
|
||||
"projectId": "A String", # [Required] ID of the project billed for storage of the table.
|
||||
"tableId": "A String", # [Required] ID of the table.
|
||||
"datasetId": "A String", # [Required] ID of the dataset containing the table.
|
||||
},
|
||||
"numRows": "A String", # [Output-only] The number of rows of data in this table.
|
||||
"numBytes": "A String", # [Output-only] The size of the table in bytes.
|
||||
"etag": "A String", # [Output-only] A hash of this resource.
|
||||
"friendlyName": "A String", # [Optional] A descriptive name for this table.
|
||||
"expirationTime": "A String", # [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
|
||||
"id": "A String", # [Output-only] An opaque ID uniquely identifying the table.
|
||||
"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.
|
||||
"schema": { # [Optional] Describes the schema of this table.
|
||||
"fields": [ # Describes the fields in a table.
|
||||
{
|
||||
"fields": [ # [Optional] Describes nested fields when type is RECORD.
|
||||
# Object with schema name: TableFieldSchema
|
||||
],
|
||||
"type": "A String", # [Required] Data type of the field.
|
||||
"mode": "A String", # [Optional] Mode of the field (whether or not it can be null. Default is NULLABLE.
|
||||
"name": "A String", # [Required] Name of the field.
|
||||
},
|
||||
],
|
||||
},
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -1,62 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one blog by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
blogId: string, The ID of the blog to get. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "blogger#blog", # The kind of this entry. Always blogger#blog<br>
|
||||
"description": "A String", # The description of this blog. This is displayed underneath the title.<br>
|
||||
"locale": { # The locale this Blog is set to.<br>
|
||||
"country": "A String", # The country this blog's locale is set to.<br>
|
||||
"variant": "A String", # The language variant this blog is authored in.<br>
|
||||
"language": "A String", # The language this blog is authored in.<br>
|
||||
},<br>
|
||||
"posts": { # The container of posts in this blog.<br>
|
||||
"totalItems": 42, # The count of posts in this blog.<br>
|
||||
"selfLink": "A String", # The URL of the container for posts in this blog.<br>
|
||||
},<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this blog was last updated.<br>
|
||||
"id": "A String", # The identifier for this resource.<br>
|
||||
"url": "A String", # The URL where this blog is published.<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this blog was published.<br>
|
||||
"pages": { # The container of pages in this blog.<br>
|
||||
"totalItems": 42, # The count of pages in this blog.<br>
|
||||
"selfLink": "A String", # The URL of the container for pages in this blog.<br>
|
||||
},<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
"name": "A String", # The name of this blog. This is displayed as the title.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,126 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one comment by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
commentId: string, The ID of the comment to get. (required)<br>
|
||||
postId: string, ID of the post to fetch posts from. (required)<br>
|
||||
blogId: string, ID of the blog to containing the comment. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.<br>
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment<br>
|
||||
"inReplyTo": { # Data about the comment this is in reply to.<br>
|
||||
"id": "A String", # The identified of the parent of this comment.<br>
|
||||
},<br>
|
||||
"author": { # The author of this Comment.<br>
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.<br>
|
||||
"image": { # The comment creator's avatar.<br>
|
||||
"url": "A String", # The comment creator's avatar URL.<br>
|
||||
},<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"id": "A String", # The identifier of the Comment creator.<br>
|
||||
},<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this comment was last updated.<br>
|
||||
"blog": { # Data about the blog containing this comment.<br>
|
||||
"id": "A String", # The identifier of the blog containing this comment.<br>
|
||||
},<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this comment was published.<br>
|
||||
"post": { # Data about the post containing this comment.<br>
|
||||
"id": "A String", # The identifier of the post containing this comment.<br>
|
||||
},<br>
|
||||
"id": "A String", # The identifier for this resource.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the comments for a blog, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
startDate: string, Earliest date of comment to fetch, a date-time with <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> formatting.<br>
|
||||
pp: string, A parameter<br>
|
||||
fetchBodies: boolean, Whether the body content of the comments is included.<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Continuation token if request is paged.<br>
|
||||
maxResults: integer, Maximum number of comments to include in the result.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
postId: string, ID of the post to fetch posts from. (required)<br>
|
||||
blogId: string, ID of the blog to fetch comments from. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.<br>
|
||||
"items": [ # The List of Comments for a Post.<br>
|
||||
{<br>
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.<br>
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment<br>
|
||||
"inReplyTo": { # Data about the comment this is in reply to.<br>
|
||||
"id": "A String", # The identified of the parent of this comment.<br>
|
||||
},<br>
|
||||
"author": { # The author of this Comment.<br>
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.<br>
|
||||
"image": { # The comment creator's avatar.<br>
|
||||
"url": "A String", # The comment creator's avatar URL.<br>
|
||||
},<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"id": "A String", # The identifier of the Comment creator.<br>
|
||||
},<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this comment was last updated.<br>
|
||||
"blog": { # Data about the blog containing this comment.<br>
|
||||
"id": "A String", # The identifier of the blog containing this comment.<br>
|
||||
},<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this comment was published.<br>
|
||||
"post": { # Data about the post containing this comment.<br>
|
||||
"id": "A String", # The identifier of the post containing this comment.<br>
|
||||
},<br>
|
||||
"id": "A String", # The identifier for this resource.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList<br>
|
||||
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,36 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-blogs"><strong><a href="blogger.v2.blogs.html">blogs</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-comments"><strong><a href="blogger.v2.comments.html">comments</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-pages"><strong><a href="blogger.v2.pages.html">pages</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-posts"><strong><a href="blogger.v2.posts.html">posts</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-users"><strong><a href="blogger.v2.users.html">users</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,101 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one blog page by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
pageId: string, The ID of the page to get. (required)<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
blogId: string, ID of the blog containing the page. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"content": "A String", # The body content of this Page, in HTML.<br>
|
||||
"kind": "blogger#page", # The kind of this entity. Always blogger#page<br>
|
||||
"author": { # The author of this Page.<br>
|
||||
"url": "A String", # The URL of the Page creator's Profile page.<br>
|
||||
"image": { # The page author's avatar.<br>
|
||||
"url": "A String", # The page author's avatar URL.<br>
|
||||
},<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"id": "A String", # The identifier of the Page creator.<br>
|
||||
},<br>
|
||||
"url": "A String", # The URL that this Page is displayed at.<br>
|
||||
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Page was last updated.<br>
|
||||
"blog": { # Data about the blog containing this Page.<br>
|
||||
"id": "A String", # The identifier of the blog containing this page.<br>
|
||||
},<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Page was published.<br>
|
||||
"id": "A String", # The identifier for this resource.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves pages for a blog, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
fetchBodies: boolean, Whether to retrieve the Page bodies.<br>
|
||||
blogId: string, ID of the blog to fetch pages from. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # The list of Pages for a Blog.<br>
|
||||
{<br>
|
||||
"content": "A String", # The body content of this Page, in HTML.<br>
|
||||
"kind": "blogger#page", # The kind of this entity. Always blogger#page<br>
|
||||
"author": { # The author of this Page.<br>
|
||||
"url": "A String", # The URL of the Page creator's Profile page.<br>
|
||||
"image": { # The page author's avatar.<br>
|
||||
"url": "A String", # The page author's avatar URL.<br>
|
||||
},<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"id": "A String", # The identifier of the Page creator.<br>
|
||||
},<br>
|
||||
"url": "A String", # The URL that this Page is displayed at.<br>
|
||||
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Page was last updated.<br>
|
||||
"blog": { # Data about the blog containing this Page.<br>
|
||||
"id": "A String", # The identifier of the blog containing this page.<br>
|
||||
},<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Page was published.<br>
|
||||
"id": "A String", # The identifier for this resource.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,130 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a post by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
postId: string, The ID of the post (required)<br>
|
||||
blogId: string, ID of the blog to fetch the post from. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.<br>
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post<br>
|
||||
"author": { # The author of this Post.<br>
|
||||
"url": "A String", # The URL of the Post creator's Profile page.<br>
|
||||
"image": { # The Post author's avatar.<br>
|
||||
"url": "A String", # The Post author's avatar URL.<br>
|
||||
},<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"id": "A String", # The identifier of the Post creator.<br>
|
||||
},<br>
|
||||
"replies": { # The container of comments on this Post.<br>
|
||||
"totalItems": "A String", # The count of comments on this post.<br>
|
||||
"selfLink": "A String", # The URL of the comments on this post.<br>
|
||||
},<br>
|
||||
"labels": [ # The list of labels this Post was tagged with.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Post was last updated.<br>
|
||||
"blog": { # Data about the blog containing this Post.<br>
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.<br>
|
||||
},<br>
|
||||
"url": "A String", # The URL where this Post is displayed.<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Post was published.<br>
|
||||
"title": "A String", # The title of the Post.<br>
|
||||
"id": "A String", # The identifier of this Post.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of posts, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
startDate: string, Earliest post date to fetch, a date-time with <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> formatting.<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
pageToken: string, Continuation token if the request is paged.<br>
|
||||
maxResults: integer, Maximum number of posts to fetch.<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
fetchBodies: boolean, Whether the body content of posts is included.<br>
|
||||
blogId: string, ID of the blog to fetch posts from. (required)<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.<br>
|
||||
"items": [ # The list of Posts for this Blog.<br>
|
||||
{<br>
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.<br>
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post<br>
|
||||
"author": { # The author of this Post.<br>
|
||||
"url": "A String", # The URL of the Post creator's Profile page.<br>
|
||||
"image": { # The Post author's avatar.<br>
|
||||
"url": "A String", # The Post author's avatar URL.<br>
|
||||
},<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"id": "A String", # The identifier of the Post creator.<br>
|
||||
},<br>
|
||||
"replies": { # The container of comments on this Post.<br>
|
||||
"totalItems": "A String", # The count of comments on this post.<br>
|
||||
"selfLink": "A String", # The URL of the comments on this post.<br>
|
||||
},<br>
|
||||
"labels": [ # The list of labels this Post was tagged with.<br>
|
||||
"A String",<br>
|
||||
],<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Post was last updated.<br>
|
||||
"blog": { # Data about the blog containing this Post.<br>
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.<br>
|
||||
},<br>
|
||||
"url": "A String", # The URL where this Post is displayed.<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this Post was published.<br>
|
||||
"title": "A String", # The title of the Post.<br>
|
||||
"id": "A String", # The identifier of this Post.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "blogger#postList", # The kind of this entity. Always blogger#postList<br>
|
||||
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
previous_request: The request for the previous page.<br>
|
||||
previous_response: The response from the request for the previous page.<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
A request object that you can call 'execute()' on to request the next<br>
|
||||
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,67 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of blogs, possibly filtered.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # The list of Blogs this user has Authorship or Admin rights over.<br>
|
||||
{<br>
|
||||
"kind": "blogger#blog", # The kind of this entry. Always blogger#blog<br>
|
||||
"description": "A String", # The description of this blog. This is displayed underneath the title.<br>
|
||||
"locale": { # The locale this Blog is set to.<br>
|
||||
"country": "A String", # The country this blog's locale is set to.<br>
|
||||
"variant": "A String", # The language variant this blog is authored in.<br>
|
||||
"language": "A String", # The language this blog is authored in.<br>
|
||||
},<br>
|
||||
"posts": { # The container of posts in this blog.<br>
|
||||
"totalItems": 42, # The count of posts in this blog.<br>
|
||||
"selfLink": "A String", # The URL of the container for posts in this blog.<br>
|
||||
},<br>
|
||||
"updated": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this blog was last updated.<br>
|
||||
"id": "A String", # The identifier for this resource.<br>
|
||||
"url": "A String", # The URL where this blog is published.<br>
|
||||
"published": "A String", # <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> date-time when this blog was published.<br>
|
||||
"pages": { # The container of pages in this blog.<br>
|
||||
"totalItems": 42, # The count of pages in this blog.<br>
|
||||
"selfLink": "A String", # The URL of the container for pages in this blog.<br>
|
||||
},<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
"name": "A String", # The name of this blog. This is displayed as the title.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
@@ -1,58 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-blogs"><strong><a href="blogger.v2.users.blogs.html">blogs</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets one user by id.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
userId: string, The ID of the user to get. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"about": "A String", # Profile summary information.<br>
|
||||
"displayName": "A String", # The display name.<br>
|
||||
"created": "A String", # The timestamp of when this profile was created, in seconds since epoch.<br>
|
||||
"locale": { # This user's locale<br>
|
||||
"country": "A String", # The user's country setting.<br>
|
||||
"variant": "A String", # The user's language variant setting.<br>
|
||||
"language": "A String", # The user's language setting.<br>
|
||||
},<br>
|
||||
"blogs": { # The container of blogs for this user.<br>
|
||||
"selfLink": "A String", # The URL of the Blogs for this user.<br>
|
||||
},<br>
|
||||
"kind": "blogger#user", # The kind of this entity. Always blogger#user<br>
|
||||
"url": "A String", # The user's profile page.<br>
|
||||
"id": "A String", # The identifier for this User.<br>
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
393
docs/dyn/blogger_v3.blogs.html
Normal file
393
docs/dyn/blogger_v3.blogs.html
Normal file
@@ -0,0 +1,393 @@
|
||||
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.blogs.html">blogs</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(blogId, maxPosts=None)</a></code></p>
|
||||
<p class="firstline">Gets one blog by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getByUrl">getByUrl(url=None)</a></code></p>
|
||||
<p class="firstline">Retrieve a Blog by URL.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#listByUser">listByUser(userId)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of blogs, possibly filtered.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(blogId, maxPosts=None)</code>
|
||||
<pre>Gets one blog by id.
|
||||
|
||||
Args:
|
||||
blogId: string, The ID of the blog to get. (required)
|
||||
maxPosts: integer, Maximum number of posts to pull back with the blog.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "blogger#blog", # The kind of this entry. Always blogger#blog
|
||||
"description": "A String", # The description of this blog. This is displayed underneath the title.
|
||||
"locale": { # The locale this Blog is set to.
|
||||
"country": "A String", # The country this blog's locale is set to.
|
||||
"variant": "A String", # The language variant this blog is authored in.
|
||||
"language": "A String", # The language this blog is authored in.
|
||||
},
|
||||
"posts": { # The container of posts in this blog.
|
||||
"totalItems": 42, # The count of posts in this blog.
|
||||
"items": [ # The List of Posts for this Blog.
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the container for posts in this blog.
|
||||
},
|
||||
"customMetaData": "A String", # The JSON custom meta-data for the Blog
|
||||
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
|
||||
"pages": { # The container of pages in this blog.
|
||||
"totalItems": 42, # The count of pages in this blog.
|
||||
"selfLink": "A String", # The URL of the container for pages in this blog.
|
||||
},
|
||||
"url": "A String", # The URL where this blog is published.
|
||||
"published": "A String", # RFC 3339 date-time when this blog was published.
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
"name": "A String", # The name of this blog. This is displayed as the title.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getByUrl">getByUrl(url=None)</code>
|
||||
<pre>Retrieve a Blog by URL.
|
||||
|
||||
Args:
|
||||
url: string, The URL of the blog to retrieve.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"kind": "blogger#blog", # The kind of this entry. Always blogger#blog
|
||||
"description": "A String", # The description of this blog. This is displayed underneath the title.
|
||||
"locale": { # The locale this Blog is set to.
|
||||
"country": "A String", # The country this blog's locale is set to.
|
||||
"variant": "A String", # The language variant this blog is authored in.
|
||||
"language": "A String", # The language this blog is authored in.
|
||||
},
|
||||
"posts": { # The container of posts in this blog.
|
||||
"totalItems": 42, # The count of posts in this blog.
|
||||
"items": [ # The List of Posts for this Blog.
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the container for posts in this blog.
|
||||
},
|
||||
"customMetaData": "A String", # The JSON custom meta-data for the Blog
|
||||
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
|
||||
"pages": { # The container of pages in this blog.
|
||||
"totalItems": 42, # The count of pages in this blog.
|
||||
"selfLink": "A String", # The URL of the container for pages in this blog.
|
||||
},
|
||||
"url": "A String", # The URL where this blog is published.
|
||||
"published": "A String", # RFC 3339 date-time when this blog was published.
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
"name": "A String", # The name of this blog. This is displayed as the title.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="listByUser">listByUser(userId)</code>
|
||||
<pre>Retrieves a list of blogs, possibly filtered.
|
||||
|
||||
Args:
|
||||
userId: string, ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [ # The list of Blogs this user has Authorship or Admin rights over.
|
||||
{
|
||||
"kind": "blogger#blog", # The kind of this entry. Always blogger#blog
|
||||
"description": "A String", # The description of this blog. This is displayed underneath the title.
|
||||
"locale": { # The locale this Blog is set to.
|
||||
"country": "A String", # The country this blog's locale is set to.
|
||||
"variant": "A String", # The language variant this blog is authored in.
|
||||
"language": "A String", # The language this blog is authored in.
|
||||
},
|
||||
"posts": { # The container of posts in this blog.
|
||||
"totalItems": 42, # The count of posts in this blog.
|
||||
"items": [ # The List of Posts for this Blog.
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the container for posts in this blog.
|
||||
},
|
||||
"customMetaData": "A String", # The JSON custom meta-data for the Blog
|
||||
"updated": "A String", # RFC 3339 date-time when this blog was last updated.
|
||||
"pages": { # The container of pages in this blog.
|
||||
"totalItems": 42, # The count of pages in this blog.
|
||||
"selfLink": "A String", # The URL of the container for pages in this blog.
|
||||
},
|
||||
"url": "A String", # The URL where this blog is published.
|
||||
"published": "A String", # RFC 3339 date-time when this blog was published.
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
"name": "A String", # The name of this blog. This is displayed as the title.
|
||||
},
|
||||
],
|
||||
"kind": "blogger#blogList", # The kind of this entity. Always blogger#blogList
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
190
docs/dyn/blogger_v3.comments.html
Normal file
190
docs/dyn/blogger_v3.comments.html
Normal file
@@ -0,0 +1,190 @@
|
||||
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.comments.html">comments</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(blogId, postId, commentId)</a></code></p>
|
||||
<p class="firstline">Gets one comment by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(blogId, postId, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None)</a></code></p>
|
||||
<p class="firstline">Retrieves the comments for a blog, possibly filtered.</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(blogId, postId, commentId)</code>
|
||||
<pre>Gets one comment by id.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to containing the comment. (required)
|
||||
postId: string, ID of the post to fetch posts from. (required)
|
||||
commentId: string, The ID of the comment to get. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(blogId, postId, startDate=None, fetchBodies=None, endDate=None, pageToken=None, maxResults=None)</code>
|
||||
<pre>Retrieves the comments for a blog, possibly filtered.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch comments from. (required)
|
||||
postId: string, ID of the post to fetch posts from. (required)
|
||||
startDate: string, Earliest date of comment to fetch, a date-time with RFC 3339 formatting.
|
||||
fetchBodies: boolean, Whether the body content of the comments is included.
|
||||
endDate: string, Latest date of comment to fetch, a date-time with RFC 3339 formatting.
|
||||
pageToken: string, Continuation token if request is paged.
|
||||
maxResults: integer, Maximum number of comments to include in the result.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
|
||||
"items": [ # The List of Comments for a Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"kind": "blogger#commentList", # The kind of this entry. Always blogger#commentList
|
||||
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
|
||||
}</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/blogger_v3.html
Normal file
102
docs/dyn/blogger_v3.html
Normal file
@@ -0,0 +1,102 @@
|
||||
<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="blogger_v3.html">Blogger API</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.blogs.html">blogs()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the blogs Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.comments.html">comments()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the comments Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.pages.html">pages()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the pages Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.posts.html">posts()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the posts Resource.</p>
|
||||
|
||||
<p class="toc_element">
|
||||
<code><a href="blogger_v3.users.html">users()</a></code>
|
||||
</p>
|
||||
<p class="firstline">Returns the users Resource.</p>
|
||||
|
||||
</body></html>
|
||||
157
docs/dyn/blogger_v3.pages.html
Normal file
157
docs/dyn/blogger_v3.pages.html
Normal file
@@ -0,0 +1,157 @@
|
||||
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.pages.html">pages</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(blogId, pageId)</a></code></p>
|
||||
<p class="firstline">Gets one blog page by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(blogId, fetchBodies=None)</a></code></p>
|
||||
<p class="firstline">Retrieves pages for a blog, possibly filtered.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(blogId, pageId)</code>
|
||||
<pre>Gets one blog page by id.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog containing the page. (required)
|
||||
pageId: string, The ID of the page to get. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The body content of this Page, in HTML.
|
||||
"kind": "blogger#page", # The kind of this entity. Always blogger#page
|
||||
"author": { # The author of this Page.
|
||||
"url": "A String", # The URL of the Page creator's Profile page.
|
||||
"image": { # The page author's avatar.
|
||||
"url": "A String", # The page author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Page creator.
|
||||
},
|
||||
"url": "A String", # The URL that this Page is displayed at.
|
||||
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
||||
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
||||
"blog": { # Data about the blog containing this Page.
|
||||
"id": "A String", # The identifier of the blog containing this page.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Page was published.
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(blogId, fetchBodies=None)</code>
|
||||
<pre>Retrieves pages for a blog, possibly filtered.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch pages from. (required)
|
||||
fetchBodies: boolean, Whether to retrieve the Page bodies.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"items": [ # The list of Pages for a Blog.
|
||||
{
|
||||
"content": "A String", # The body content of this Page, in HTML.
|
||||
"kind": "blogger#page", # The kind of this entity. Always blogger#page
|
||||
"author": { # The author of this Page.
|
||||
"url": "A String", # The URL of the Page creator's Profile page.
|
||||
"image": { # The page author's avatar.
|
||||
"url": "A String", # The page author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Page creator.
|
||||
},
|
||||
"url": "A String", # The URL that this Page is displayed at.
|
||||
"title": "A String", # The title of this entity. This is the name displayed in the Admin user interface.
|
||||
"updated": "A String", # RFC 3339 date-time when this Page was last updated.
|
||||
"blog": { # Data about the blog containing this Page.
|
||||
"id": "A String", # The identifier of the blog containing this page.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Page was published.
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"kind": "blogger#pageList", # The kind of this entity. Always blogger#pageList
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
872
docs/dyn/blogger_v3.posts.html
Normal file
872
docs/dyn/blogger_v3.posts.html
Normal file
@@ -0,0 +1,872 @@
|
||||
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.posts.html">posts</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#delete">delete(blogId, postId)</a></code></p>
|
||||
<p class="firstline">Delete a post by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(blogId, postId, maxComments=None)</a></code></p>
|
||||
<p class="firstline">Get a post by id.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#getByPath">getByPath(blogId, path=None, maxComments=None)</a></code></p>
|
||||
<p class="firstline">Retrieve a Post by Path.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#insert">insert(blogId, body)</a></code></p>
|
||||
<p class="firstline">Add a post.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#list">list(blogId, startDate=None, endDate=None, pageToken=None, labels=None, maxResults=None, fetchBodies=None)</a></code></p>
|
||||
<p class="firstline">Retrieves a list of posts, possibly filtered.</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(blogId, postId, body)</a></code></p>
|
||||
<p class="firstline">Update a post. This method supports patch semantics.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#search">search(blogId, q=None)</a></code></p>
|
||||
<p class="firstline">Search for a post.</p>
|
||||
<p class="toc_element">
|
||||
<code><a href="#update">update(blogId, postId, body)</a></code></p>
|
||||
<p class="firstline">Update a post.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="delete">delete(blogId, postId)</code>
|
||||
<pre>Delete a post by id.
|
||||
|
||||
Args:
|
||||
blogId: string, The Id of the Blog. (required)
|
||||
postId: string, The ID of the Post. (required)
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(blogId, postId, maxComments=None)</code>
|
||||
<pre>Get a post by id.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
postId: string, The ID of the post (required)
|
||||
maxComments: integer, Maximum number of comments to pull back on a post.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="getByPath">getByPath(blogId, path=None, maxComments=None)</code>
|
||||
<pre>Retrieve a Post by Path.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
path: string, Path of the Post to retrieve.
|
||||
maxComments: integer, Maximum number of comments to pull back on a post.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="insert">insert(blogId, body)</code>
|
||||
<pre>Add a post.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="list">list(blogId, startDate=None, endDate=None, pageToken=None, labels=None, maxResults=None, fetchBodies=None)</code>
|
||||
<pre>Retrieves a list of posts, possibly filtered.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch posts from. (required)
|
||||
startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
|
||||
endDate: string, Latest post date to fetch, a date-time with RFC 3339 formatting.
|
||||
pageToken: string, Continuation token if the request is paged.
|
||||
labels: string, Comma-separated list of labels to search for.
|
||||
maxResults: integer, Maximum number of posts to fetch.
|
||||
fetchBodies: boolean, Whether the body content of posts is included.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
|
||||
"items": [ # The list of Posts for this Blog.
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"kind": "blogger#postList", # The kind of this entity. Always blogger#postList
|
||||
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
|
||||
}</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(blogId, postId, body)</code>
|
||||
<pre>Update a post. This method supports patch semantics.
|
||||
|
||||
Args:
|
||||
blogId: string, The ID of the Blog. (required)
|
||||
postId: string, The ID of the Post. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="search">search(blogId, q=None)</code>
|
||||
<pre>Search for a post.
|
||||
|
||||
Args:
|
||||
blogId: string, ID of the blog to fetch the post from. (required)
|
||||
q: string, Query terms to search this blog for matching posts.
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
|
||||
"items": [ # The list of Posts for this Blog.
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"kind": "blogger#postList", # The kind of this entity. Always blogger#postList
|
||||
"prevPageToken": "A String", # Pagination token to fetch the previous page, if one exists.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
<div class="method">
|
||||
<code class="details" id="update">update(blogId, postId, body)</code>
|
||||
<pre>Update a post.
|
||||
|
||||
Args:
|
||||
blogId: string, The ID of the Blog. (required)
|
||||
postId: string, The ID of the Post. (required)
|
||||
body: object, The request body. (required)
|
||||
The object takes the form of:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}
|
||||
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"content": "A String", # The content of the Post. May contain HTML markup.
|
||||
"kind": "blogger#post", # The kind of this entity. Always blogger#post
|
||||
"author": { # The author of this Post.
|
||||
"url": "A String", # The URL of the Post creator's Profile page.
|
||||
"image": { # The Post author's avatar.
|
||||
"url": "A String", # The Post author's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Post creator.
|
||||
},
|
||||
"replies": { # The container of comments on this Post.
|
||||
"totalItems": "A String", # The count of comments on this post.
|
||||
"items": [ # The List of Comments for this Post.
|
||||
{
|
||||
"content": "A String", # The actual content of the comment. May include HTML markup.
|
||||
"kind": "blogger#comment", # The kind of this entry. Always blogger#comment
|
||||
"inReplyTo": { # Data about the comment this is in reply to.
|
||||
"id": "A String", # The identified of the parent of this comment.
|
||||
},
|
||||
"author": { # The author of this Comment.
|
||||
"url": "A String", # The URL of the Comment creator's Profile page.
|
||||
"image": { # The comment creator's avatar.
|
||||
"url": "A String", # The comment creator's avatar URL.
|
||||
},
|
||||
"displayName": "A String", # The display name.
|
||||
"id": "A String", # The identifier of the Comment creator.
|
||||
},
|
||||
"updated": "A String", # RFC 3339 date-time when this comment was last updated.
|
||||
"blog": { # Data about the blog containing this comment.
|
||||
"id": "A String", # The identifier of the blog containing this comment.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this comment was published.
|
||||
"post": { # Data about the post containing this comment.
|
||||
"id": "A String", # The identifier of the post containing this comment.
|
||||
},
|
||||
"id": "A String", # The identifier for this resource.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
},
|
||||
],
|
||||
"selfLink": "A String", # The URL of the comments on this post.
|
||||
},
|
||||
"labels": [ # The list of labels this Post was tagged with.
|
||||
"A String",
|
||||
],
|
||||
"customMetaData": "A String", # The JSON meta-data for the Post.
|
||||
"updated": "A String", # RFC 3339 date-time when this Post was last updated.
|
||||
"blog": { # Data about the blog containing this Post.
|
||||
"id": "A String", # The identifier of the Blog that contains this Post.
|
||||
},
|
||||
"url": "A String", # The URL where this Post is displayed.
|
||||
"location": { # The location for geotagged posts.
|
||||
"lat": 3.14, # Location's latitude.
|
||||
"lng": 3.14, # Location's longitude.
|
||||
"span": "A String", # Location's viewport span. Can be used when rendering a map preview.
|
||||
"name": "A String", # Location name.
|
||||
},
|
||||
"published": "A String", # RFC 3339 date-time when this Post was published.
|
||||
"title": "A String", # The title of the Post.
|
||||
"id": "A String", # The identifier of this Post.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
110
docs/dyn/blogger_v3.users.html
Normal file
110
docs/dyn/blogger_v3.users.html
Normal file
@@ -0,0 +1,110 @@
|
||||
<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="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.users.html">users</a></h1>
|
||||
<h2>Instance Methods</h2>
|
||||
<p class="toc_element">
|
||||
<code><a href="#get">get(userId)</a></code></p>
|
||||
<p class="firstline">Gets one user by id.</p>
|
||||
<h3>Method Details</h3>
|
||||
<div class="method">
|
||||
<code class="details" id="get">get(userId)</code>
|
||||
<pre>Gets one user by id.
|
||||
|
||||
Args:
|
||||
userId: string, The ID of the user to get. (required)
|
||||
|
||||
Returns:
|
||||
An object of the form:
|
||||
|
||||
{
|
||||
"about": "A String", # Profile summary information.
|
||||
"displayName": "A String", # The display name.
|
||||
"created": "A String", # The timestamp of when this profile was created, in seconds since epoch.
|
||||
"locale": { # This user's locale
|
||||
"country": "A String", # The user's country setting.
|
||||
"variant": "A String", # The user's language variant setting.
|
||||
"language": "A String", # The user's language setting.
|
||||
},
|
||||
"blogs": { # The container of blogs for this user.
|
||||
"selfLink": "A String", # The URL of the Blogs for this user.
|
||||
},
|
||||
"kind": "blogger#user", # The kind of this entity. Always blogger#user
|
||||
"url": "A String", # The user's profile page.
|
||||
"id": "A String", # The identifier for this User.
|
||||
"selfLink": "A String", # The API REST URL to fetch this resource from.
|
||||
}</pre>
|
||||
</div>
|
||||
|
||||
</body></html>
|
||||
@@ -1,86 +0,0 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: class Resource</title>
|
||||
</head><body bgcolor="#f0f0f8">
|
||||
<p>
|
||||
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||||
<tr bgcolor="#ffc8d8">
|
||||
<td colspan=3 valign=bottom> <br>
|
||||
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves metadata for a specific bookshelf for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
shelf: string, ID of bookshelf to retrieve. (required)<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"kind": "books#bookshelf", # Resource type for bookshelf metadata.<br>
|
||||
"description": "A String", # Description of this bookshelf.<br>
|
||||
"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeCount": 42, # Number of volumes in this bookshelf.<br>
|
||||
"title": "A String", # Title of this bookshelf.<br>
|
||||
"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.<br>
|
||||
"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"id": 42, # Id of this bookshelf, only unique by user.<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves a list of public bookshelves for the specified user.<br>
|
||||
<br>
|
||||
Args:<br>
|
||||
pp: string, A parameter<br>
|
||||
trace: string, A parameter<br>
|
||||
source: string, String to identify the originator of this request.<br>
|
||||
userId: string, ID of user for whom to retrieve bookshelves. (required)<br>
|
||||
strict: string, A parameter<br>
|
||||
userip: string, A parameter<br>
|
||||
<br>
|
||||
Returns:<br>
|
||||
An object of the form<br>
|
||||
<br>
|
||||
{<br>
|
||||
"items": [ # A list of bookshelves.<br>
|
||||
{<br>
|
||||
"kind": "books#bookshelf", # Resource type for bookshelf metadata.<br>
|
||||
"description": "A String", # Description of this bookshelf.<br>
|
||||
"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"volumeCount": 42, # Number of volumes in this bookshelf.<br>
|
||||
"title": "A String", # Title of this bookshelf.<br>
|
||||
"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.<br>
|
||||
"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).<br>
|
||||
"id": 42, # Id of this bookshelf, only unique by user.<br>
|
||||
"selfLink": "A String", # URL to this resource.<br>
|
||||
},<br>
|
||||
],<br>
|
||||
"kind": "books#bookshelves", # Resource type.<br>
|
||||
}</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Resource-volumes"><strong><a href="books.v1.bookshelves.volumes.html">volumes</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Data descriptors defined here:<br>
|
||||
<dl><dt><strong>__dict__</strong></dt>
|
||||
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||||
</dl>
|
||||
<dl><dt><strong>__weakref__</strong></dt>
|
||||
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||||
</dl>
|
||||
</td></tr></table>
|
||||
</body></html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user