blob: f300677ca4f87d2a1dcd3227b936ce44e7380eec [file] [log] [blame]
<!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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;one&nbsp;direct&nbsp;deal&nbsp;by&nbsp;ID.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;direct&nbsp;deal&nbsp;id&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;"advertiser":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;advertiser&nbsp;this&nbsp;deal&nbsp;is&nbsp;for.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#directDeal",&nbsp;#&nbsp;Resource&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;currency&nbsp;code&nbsp;that&nbsp;applies&nbsp;to&nbsp;the&nbsp;fixed_cpm&nbsp;value.&nbsp;If&nbsp;not&nbsp;set&nbsp;then&nbsp;assumed&nbsp;to&nbsp;be&nbsp;USD.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"fixedCpm":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;fixed&nbsp;price&nbsp;for&nbsp;this&nbsp;direct&nbsp;deal.&nbsp;In&nbsp;cpm&nbsp;micros&nbsp;of&nbsp;currency&nbsp;according&nbsp;to&nbsp;currency_code.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"startTime":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Start&nbsp;time&nbsp;for&nbsp;when&nbsp;this&nbsp;deal&nbsp;becomes&nbsp;active.&nbsp;If&nbsp;not&nbsp;set&nbsp;then&nbsp;this&nbsp;deal&nbsp;is&nbsp;active&nbsp;immediately&nbsp;upon&nbsp;creation.&nbsp;In&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"endTime":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;End&nbsp;time&nbsp;for&nbsp;when&nbsp;this&nbsp;deal&nbsp;stops&nbsp;being&nbsp;active.&nbsp;If&nbsp;not&nbsp;set&nbsp;then&nbsp;this&nbsp;deal&nbsp;is&nbsp;valid&nbsp;until&nbsp;manually&nbsp;disabled&nbsp;by&nbsp;the&nbsp;publisher.&nbsp;In&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"sellerNetwork":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;publisher&nbsp;offering&nbsp;this&nbsp;direct&nbsp;deal.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Deal&nbsp;id.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;42,&nbsp;#&nbsp;The&nbsp;account&nbsp;id&nbsp;of&nbsp;the&nbsp;buyer&nbsp;this&nbsp;deal&nbsp;is&nbsp;for.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;the&nbsp;authenticated&nbsp;user's&nbsp;list&nbsp;of&nbsp;direct&nbsp;deals.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<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;"adexchangebuyer#directDealsList",&nbsp;#&nbsp;Resource&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"directDeals":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;direct&nbsp;deals&nbsp;relevant&nbsp;for&nbsp;your&nbsp;account.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiser":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;advertiser&nbsp;this&nbsp;deal&nbsp;is&nbsp;for.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#directDeal",&nbsp;#&nbsp;Resource&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currencyCode":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;currency&nbsp;code&nbsp;that&nbsp;applies&nbsp;to&nbsp;the&nbsp;fixed_cpm&nbsp;value.&nbsp;If&nbsp;not&nbsp;set&nbsp;then&nbsp;assumed&nbsp;to&nbsp;be&nbsp;USD.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"fixedCpm":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;fixed&nbsp;price&nbsp;for&nbsp;this&nbsp;direct&nbsp;deal.&nbsp;In&nbsp;cpm&nbsp;micros&nbsp;of&nbsp;currency&nbsp;according&nbsp;to&nbsp;currency_code.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"startTime":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Start&nbsp;time&nbsp;for&nbsp;when&nbsp;this&nbsp;deal&nbsp;becomes&nbsp;active.&nbsp;If&nbsp;not&nbsp;set&nbsp;then&nbsp;this&nbsp;deal&nbsp;is&nbsp;active&nbsp;immediately&nbsp;upon&nbsp;creation.&nbsp;In&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"endTime":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;End&nbsp;time&nbsp;for&nbsp;when&nbsp;this&nbsp;deal&nbsp;stops&nbsp;being&nbsp;active.&nbsp;If&nbsp;not&nbsp;set&nbsp;then&nbsp;this&nbsp;deal&nbsp;is&nbsp;valid&nbsp;until&nbsp;manually&nbsp;disabled&nbsp;by&nbsp;the&nbsp;publisher.&nbsp;In&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sellerNetwork":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;publisher&nbsp;offering&nbsp;this&nbsp;direct&nbsp;deal.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Deal&nbsp;id.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;42,&nbsp;#&nbsp;The&nbsp;account&nbsp;id&nbsp;of&nbsp;the&nbsp;buyer&nbsp;this&nbsp;deal&nbsp;is&nbsp;for.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;}</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>