blob: f300677ca4f87d2a1dcd3227b936ce44e7380eec [file] [log] [blame]
Joe Gregorio41899542012-04-23 09:02:05 -04001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<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>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -040020&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -040024&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;direct&nbsp;deal&nbsp;id&nbsp;(required)<br>
25&nbsp;<br>
26Returns:<br>
27&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
28&nbsp;<br>
29&nbsp;&nbsp;&nbsp;&nbsp;{<br>
30&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>
31&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#directDeal",&nbsp;#&nbsp;Resource&nbsp;type.<br>
32&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>
33&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>
34&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>
35&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>
36&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>
37&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Deal&nbsp;id.<br>
38&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>
39&nbsp;&nbsp;}</tt></dd></dl>
40
41<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>
42&nbsp;<br>
43Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -040044&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
45&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
46&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
47&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -040048&nbsp;<br>
49Returns:<br>
50&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
51&nbsp;<br>
52&nbsp;&nbsp;&nbsp;&nbsp;{<br>
53&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#directDealsList",&nbsp;#&nbsp;Resource&nbsp;type.<br>
54&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>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
56&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>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#directDeal",&nbsp;#&nbsp;Resource&nbsp;type.<br>
58&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>
59&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>
60&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>
61&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>
62&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>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Deal&nbsp;id.<br>
64&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>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
66&nbsp;&nbsp;&nbsp;&nbsp;],<br>
67&nbsp;&nbsp;}</tt></dd></dl>
68
69<hr>
70Data descriptors defined here:<br>
71<dl><dt><strong>__dict__</strong></dt>
72<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
73</dl>
74<dl><dt><strong>__weakref__</strong></dt>
75<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
76</dl>
77</td></tr></table>
78</body></html>