docs/dyn/adsense.v1.1.customchannels.html - platform/external/python/google-api-python-client - Gitiles


 <!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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</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&nbsp;collection&nbsp;resource.</tt></dd></dl>

 <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;the&nbsp;specified&nbsp;custom&nbsp;channel&nbsp;from&nbsp;the&nbsp;specified&nbsp;ad&nbsp;client.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;customChannelId:&nbsp;string,&nbsp;Custom&nbsp;channel&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
 &nbsp;&nbsp;adClientId:&nbsp;string,&nbsp;Ad&nbsp;client&nbsp;which&nbsp;contains&nbsp;the&nbsp;custom&nbsp;channel.&nbsp;(required)<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#customChannel",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#customChannel.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"code":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Code&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel,&nbsp;not&nbsp;necessarily&nbsp;unique&nbsp;across&nbsp;ad&nbsp;clients.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"targetingInfo":&nbsp;{&nbsp;#&nbsp;The&nbsp;targeting&nbsp;information&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel,&nbsp;if&nbsp;activated.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;locations&nbsp;in&nbsp;which&nbsp;ads&nbsp;appear.&nbsp;(Only&nbsp;valid&nbsp;for&nbsp;content&nbsp;and&nbsp;mobile&nbsp;content&nbsp;ads).&nbsp;Acceptable&nbsp;values&nbsp;for&nbsp;content&nbsp;ads&nbsp;are:&nbsp;TOP_LEFT,&nbsp;TOP_CENTER,&nbsp;TOP_RIGHT,&nbsp;MIDDLE_LEFT,&nbsp;MIDDLE_CENTER,&nbsp;MIDDLE_RIGHT,&nbsp;BOTTOM_LEFT,&nbsp;BOTTOM_CENTER,&nbsp;BOTTOM_RIGHT,&nbsp;MULTIPLE_LOCATIONS.&nbsp;Acceptable&nbsp;values&nbsp;for&nbsp;mobile&nbsp;content&nbsp;ads&nbsp;are:&nbsp;TOP,&nbsp;MIDDLE,&nbsp;BOTTOM,&nbsp;MULTIPLE_LOCATIONS.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adsAppearOn":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;used&nbsp;to&nbsp;describe&nbsp;this&nbsp;channel&nbsp;externally.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"siteLanguage":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;language&nbsp;of&nbsp;the&nbsp;sites&nbsp;ads&nbsp;will&nbsp;be&nbsp;displayed&nbsp;on.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;external&nbsp;description&nbsp;of&nbsp;the&nbsp;channel.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel.&nbsp;This&nbsp;should&nbsp;be&nbsp;considered&nbsp;an&nbsp;opaque&nbsp;identifier;&nbsp;it&nbsp;is&nbsp;not&nbsp;safe&nbsp;to&nbsp;rely&nbsp;on&nbsp;it&nbsp;being&nbsp;in&nbsp;any&nbsp;particular&nbsp;format.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel.<br>
 &nbsp;&nbsp;}</tt></dd></dl>

 <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;all&nbsp;custom&nbsp;channels&nbsp;in&nbsp;the&nbsp;specified&nbsp;ad&nbsp;client&nbsp;for&nbsp;this&nbsp;AdSense&nbsp;account.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;custom&nbsp;channels.&nbsp;To&nbsp;retrieve&nbsp;the&nbsp;next&nbsp;page,&nbsp;set&nbsp;this&nbsp;parameter&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;"nextPageToken"&nbsp;from&nbsp;the&nbsp;previous&nbsp;response.<br>
 &nbsp;&nbsp;adClientId:&nbsp;string,&nbsp;Ad&nbsp;client&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;custom&nbsp;channels.&nbsp;(required)<br>
 &nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;custom&nbsp;channels&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Continuation&nbsp;token&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;custom&nbsp;channels.&nbsp;To&nbsp;retrieve&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results,&nbsp;set&nbsp;the&nbsp;next&nbsp;request's&nbsp;"pageToken"&nbsp;value&nbsp;to&nbsp;this.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;custom&nbsp;channels&nbsp;returned&nbsp;in&nbsp;this&nbsp;list&nbsp;response.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#customChannel",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#customChannel.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"code":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Code&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel,&nbsp;not&nbsp;necessarily&nbsp;unique&nbsp;across&nbsp;ad&nbsp;clients.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"targetingInfo":&nbsp;{&nbsp;#&nbsp;The&nbsp;targeting&nbsp;information&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel,&nbsp;if&nbsp;activated.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;locations&nbsp;in&nbsp;which&nbsp;ads&nbsp;appear.&nbsp;(Only&nbsp;valid&nbsp;for&nbsp;content&nbsp;and&nbsp;mobile&nbsp;content&nbsp;ads).&nbsp;Acceptable&nbsp;values&nbsp;for&nbsp;content&nbsp;ads&nbsp;are:&nbsp;TOP_LEFT,&nbsp;TOP_CENTER,&nbsp;TOP_RIGHT,&nbsp;MIDDLE_LEFT,&nbsp;MIDDLE_CENTER,&nbsp;MIDDLE_RIGHT,&nbsp;BOTTOM_LEFT,&nbsp;BOTTOM_CENTER,&nbsp;BOTTOM_RIGHT,&nbsp;MULTIPLE_LOCATIONS.&nbsp;Acceptable&nbsp;values&nbsp;for&nbsp;mobile&nbsp;content&nbsp;ads&nbsp;are:&nbsp;TOP,&nbsp;MIDDLE,&nbsp;BOTTOM,&nbsp;MULTIPLE_LOCATIONS.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adsAppearOn":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;used&nbsp;to&nbsp;describe&nbsp;this&nbsp;channel&nbsp;externally.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"siteLanguage":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;language&nbsp;of&nbsp;the&nbsp;sites&nbsp;ads&nbsp;will&nbsp;be&nbsp;displayed&nbsp;on.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;external&nbsp;description&nbsp;of&nbsp;the&nbsp;channel.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel.&nbsp;This&nbsp;should&nbsp;be&nbsp;considered&nbsp;an&nbsp;opaque&nbsp;identifier;&nbsp;it&nbsp;is&nbsp;not&nbsp;safe&nbsp;to&nbsp;rely&nbsp;on&nbsp;it&nbsp;being&nbsp;in&nbsp;any&nbsp;particular&nbsp;format.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;custom&nbsp;channel.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adsense#customChannels",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;list&nbsp;this&nbsp;is,&nbsp;in&nbsp;this&nbsp;case&nbsp;adsense#customChannels.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;this&nbsp;response&nbsp;for&nbsp;caching&nbsp;purposes.<br>
 &nbsp;&nbsp;}</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&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
 &nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!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>
	customChannelId: string, Custom channel to retrieve. (required)<br>
	adClientId: string, Ad client which contains the custom channel. (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 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>
	"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>