Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 84e4180c0b4b453ee9fc59f026e00631bc7af2d2 / . / docs / dyn / adexchangebuyer.v1.creatives.html
blob: 4247c9e9c3a76032fe70230ceec2a1c6d317b6ac [file] [log] [blame]
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]1
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;the&nbsp;status&nbsp;for&nbsp;a&nbsp;single&nbsp;creative.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;adgroupId:&nbsp;string,&nbsp;The&nbsp;adgroup&nbsp;this&nbsp;creative&nbsp;belongs&nbsp;to.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
23&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]24&nbsp;&nbsp;buyerCreativeId:&nbsp;string,&nbsp;The&nbsp;buyer-specific&nbsp;id&nbsp;for&nbsp;this&nbsp;creative.&nbsp;(required)<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]25&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]26&nbsp;&nbsp;accountId:&nbsp;integer,&nbsp;The&nbsp;id&nbsp;for&nbsp;the&nbsp;account&nbsp;that&nbsp;will&nbsp;serve&nbsp;this&nbsp;creative.&nbsp;(required)<br>
27&nbsp;<br>
28Returns:<br>
29&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
30&nbsp;<br>
31&nbsp;&nbsp;&nbsp;&nbsp;{<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"productCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;product&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;company&nbsp;being&nbsp;advertised&nbsp;in&nbsp;the&nbsp;creative.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adgroupId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;pretargeting&nbsp;adgroup&nbsp;id&nbsp;that&nbsp;this&nbsp;creative&nbsp;will&nbsp;be&nbsp;associated&nbsp;with.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoURL":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;to&nbsp;fetch&nbsp;a&nbsp;video&nbsp;ad.&nbsp;If&nbsp;set,&nbsp;HTMLSnippet&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"width":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;width.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribute":&nbsp;[&nbsp;#&nbsp;All&nbsp;attributes&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#creative",&nbsp;#&nbsp;Resource&nbsp;type.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"height":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;height.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserId":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;advertiser&nbsp;id,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"HTMLSnippet":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;HTML&nbsp;snippet&nbsp;that&nbsp;displays&nbsp;the&nbsp;ad&nbsp;when&nbsp;inserted&nbsp;in&nbsp;the&nbsp;web&nbsp;page.&nbsp;If&nbsp;set,&nbsp;videoURL&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Creative&nbsp;serving&nbsp;status.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"buyerCreativeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;buyer-specific&nbsp;id&nbsp;identifying&nbsp;the&nbsp;creative&nbsp;in&nbsp;this&nbsp;ad.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clickThroughUrl":&nbsp;[&nbsp;#&nbsp;The&nbsp;set&nbsp;of&nbsp;destination&nbsp;urls&nbsp;for&nbsp;the&nbsp;snippet.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vendorType":&nbsp;[&nbsp;#&nbsp;All&nbsp;vendor&nbsp;types&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disapprovalReasons":&nbsp;[&nbsp;#&nbsp;The&nbsp;reason&nbsp;for&nbsp;disapproval,&nbsp;if&nbsp;any.&nbsp;Note&nbsp;that&nbsp;not&nbsp;all&nbsp;disapproval&nbsp;reasons&nbsp;may&nbsp;be&nbsp;categorized,&nbsp;so&nbsp;it&nbsp;is&nbsp;possible&nbsp;for&nbsp;the&nbsp;creative&nbsp;to&nbsp;have&nbsp;a&nbsp;status&nbsp;of&nbsp;DISAPPROVED&nbsp;with&nbsp;an&nbsp;empty&nbsp;list&nbsp;for&nbsp;disapproval_reasons.&nbsp;In&nbsp;this&nbsp;case,&nbsp;please&nbsp;reach&nbsp;out&nbsp;to&nbsp;your&nbsp;TAM&nbsp;to&nbsp;help&nbsp;debug&nbsp;the&nbsp;issue.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sensitiveCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;sensitive&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;42,&nbsp;#&nbsp;Account&nbsp;id.<br>
63&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
64
65<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Submit&nbsp;a&nbsp;new&nbsp;creative.<br>
66&nbsp;<br>
67Args:<br>
68&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
69&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
70&nbsp;<br>
71{<br>
72&nbsp;&nbsp;&nbsp;&nbsp;"productCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;product&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
74&nbsp;&nbsp;&nbsp;&nbsp;],<br>
75&nbsp;&nbsp;&nbsp;&nbsp;"advertiserName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;company&nbsp;being&nbsp;advertised&nbsp;in&nbsp;the&nbsp;creative.<br>
76&nbsp;&nbsp;&nbsp;&nbsp;"adgroupId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;pretargeting&nbsp;adgroup&nbsp;id&nbsp;that&nbsp;this&nbsp;creative&nbsp;will&nbsp;be&nbsp;associated&nbsp;with.<br>
77&nbsp;&nbsp;&nbsp;&nbsp;"videoURL":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;to&nbsp;fetch&nbsp;a&nbsp;video&nbsp;ad.&nbsp;If&nbsp;set,&nbsp;HTMLSnippet&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
78&nbsp;&nbsp;&nbsp;&nbsp;"width":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;width.<br>
79&nbsp;&nbsp;&nbsp;&nbsp;"attribute":&nbsp;[&nbsp;#&nbsp;All&nbsp;attributes&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
81&nbsp;&nbsp;&nbsp;&nbsp;],<br>
82&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#creative",&nbsp;#&nbsp;Resource&nbsp;type.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;"height":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;height.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;"advertiserId":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;advertiser&nbsp;id,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
86&nbsp;&nbsp;&nbsp;&nbsp;],<br>
87&nbsp;&nbsp;&nbsp;&nbsp;"HTMLSnippet":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;HTML&nbsp;snippet&nbsp;that&nbsp;displays&nbsp;the&nbsp;ad&nbsp;when&nbsp;inserted&nbsp;in&nbsp;the&nbsp;web&nbsp;page.&nbsp;If&nbsp;set,&nbsp;videoURL&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Creative&nbsp;serving&nbsp;status.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;"buyerCreativeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;buyer-specific&nbsp;id&nbsp;identifying&nbsp;the&nbsp;creative&nbsp;in&nbsp;this&nbsp;ad.<br>
90&nbsp;&nbsp;&nbsp;&nbsp;"clickThroughUrl":&nbsp;[&nbsp;#&nbsp;The&nbsp;set&nbsp;of&nbsp;destination&nbsp;urls&nbsp;for&nbsp;the&nbsp;snippet.<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
92&nbsp;&nbsp;&nbsp;&nbsp;],<br>
93&nbsp;&nbsp;&nbsp;&nbsp;"vendorType":&nbsp;[&nbsp;#&nbsp;All&nbsp;vendor&nbsp;types&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
94&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
95&nbsp;&nbsp;&nbsp;&nbsp;],<br>
96&nbsp;&nbsp;&nbsp;&nbsp;"disapprovalReasons":&nbsp;[&nbsp;#&nbsp;The&nbsp;reason&nbsp;for&nbsp;disapproval,&nbsp;if&nbsp;any.&nbsp;Note&nbsp;that&nbsp;not&nbsp;all&nbsp;disapproval&nbsp;reasons&nbsp;may&nbsp;be&nbsp;categorized,&nbsp;so&nbsp;it&nbsp;is&nbsp;possible&nbsp;for&nbsp;the&nbsp;creative&nbsp;to&nbsp;have&nbsp;a&nbsp;status&nbsp;of&nbsp;DISAPPROVED&nbsp;with&nbsp;an&nbsp;empty&nbsp;list&nbsp;for&nbsp;disapproval_reasons.&nbsp;In&nbsp;this&nbsp;case,&nbsp;please&nbsp;reach&nbsp;out&nbsp;to&nbsp;your&nbsp;TAM&nbsp;to&nbsp;help&nbsp;debug&nbsp;the&nbsp;issue.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
97&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
98&nbsp;&nbsp;&nbsp;&nbsp;],<br>
99&nbsp;&nbsp;&nbsp;&nbsp;"sensitiveCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;sensitive&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
101&nbsp;&nbsp;&nbsp;&nbsp;],<br>
102&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;42,&nbsp;#&nbsp;Account&nbsp;id.<br>
103&nbsp;&nbsp;}<br>
104&nbsp;<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]105&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
106&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
107&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
108&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]109&nbsp;<br>
110Returns:<br>
111&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
112&nbsp;<br>
113&nbsp;&nbsp;&nbsp;&nbsp;{<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"productCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;product&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;company&nbsp;being&nbsp;advertised&nbsp;in&nbsp;the&nbsp;creative.<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adgroupId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;pretargeting&nbsp;adgroup&nbsp;id&nbsp;that&nbsp;this&nbsp;creative&nbsp;will&nbsp;be&nbsp;associated&nbsp;with.<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoURL":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;to&nbsp;fetch&nbsp;a&nbsp;video&nbsp;ad.&nbsp;If&nbsp;set,&nbsp;HTMLSnippet&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"width":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;width.<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribute":&nbsp;[&nbsp;#&nbsp;All&nbsp;attributes&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#creative",&nbsp;#&nbsp;Resource&nbsp;type.<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"height":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;height.<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserId":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;advertiser&nbsp;id,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"HTMLSnippet":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;HTML&nbsp;snippet&nbsp;that&nbsp;displays&nbsp;the&nbsp;ad&nbsp;when&nbsp;inserted&nbsp;in&nbsp;the&nbsp;web&nbsp;page.&nbsp;If&nbsp;set,&nbsp;videoURL&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Creative&nbsp;serving&nbsp;status.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"buyerCreativeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;buyer-specific&nbsp;id&nbsp;identifying&nbsp;the&nbsp;creative&nbsp;in&nbsp;this&nbsp;ad.<br>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clickThroughUrl":&nbsp;[&nbsp;#&nbsp;The&nbsp;set&nbsp;of&nbsp;destination&nbsp;urls&nbsp;for&nbsp;the&nbsp;snippet.<br>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vendorType":&nbsp;[&nbsp;#&nbsp;All&nbsp;vendor&nbsp;types&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disapprovalReasons":&nbsp;[&nbsp;#&nbsp;The&nbsp;reason&nbsp;for&nbsp;disapproval,&nbsp;if&nbsp;any.&nbsp;Note&nbsp;that&nbsp;not&nbsp;all&nbsp;disapproval&nbsp;reasons&nbsp;may&nbsp;be&nbsp;categorized,&nbsp;so&nbsp;it&nbsp;is&nbsp;possible&nbsp;for&nbsp;the&nbsp;creative&nbsp;to&nbsp;have&nbsp;a&nbsp;status&nbsp;of&nbsp;DISAPPROVED&nbsp;with&nbsp;an&nbsp;empty&nbsp;list&nbsp;for&nbsp;disapproval_reasons.&nbsp;In&nbsp;this&nbsp;case,&nbsp;please&nbsp;reach&nbsp;out&nbsp;to&nbsp;your&nbsp;TAM&nbsp;to&nbsp;help&nbsp;debug&nbsp;the&nbsp;issue.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sensitiveCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;sensitive&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;42,&nbsp;#&nbsp;Account&nbsp;id.<br>
145&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
146
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]147<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;a&nbsp;list&nbsp;of&nbsp;the&nbsp;authenticated&nbsp;user's&nbsp;active&nbsp;creatives.<br>
148&nbsp;<br>
149Args:<br>
150&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
151&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
152&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;ad&nbsp;clients.&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.&nbsp;Optional.<br>
153&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;entries&nbsp;returned&nbsp;on&nbsp;one&nbsp;result&nbsp;page.&nbsp;If&nbsp;not&nbsp;set,&nbsp;the&nbsp;default&nbsp;is&nbsp;100.&nbsp;Optional.<br>
154&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
155&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
156&nbsp;<br>
157Returns:<br>
158&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
159&nbsp;<br>
160&nbsp;&nbsp;&nbsp;&nbsp;{<br>
161&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;creatives.<br>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"productCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;product&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;company&nbsp;being&nbsp;advertised&nbsp;in&nbsp;the&nbsp;creative.<br>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adgroupId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;pretargeting&nbsp;adgroup&nbsp;id&nbsp;that&nbsp;this&nbsp;creative&nbsp;will&nbsp;be&nbsp;associated&nbsp;with.<br>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoURL":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;url&nbsp;to&nbsp;fetch&nbsp;a&nbsp;video&nbsp;ad.&nbsp;If&nbsp;set,&nbsp;HTMLSnippet&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"width":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;width.<br>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"attribute":&nbsp;[&nbsp;#&nbsp;All&nbsp;attributes&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#creative",&nbsp;#&nbsp;Resource&nbsp;type.<br>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"height":&nbsp;42,&nbsp;#&nbsp;Ad&nbsp;height.<br>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"advertiserId":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;advertiser&nbsp;id,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"HTMLSnippet":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;HTML&nbsp;snippet&nbsp;that&nbsp;displays&nbsp;the&nbsp;ad&nbsp;when&nbsp;inserted&nbsp;in&nbsp;the&nbsp;web&nbsp;page.&nbsp;If&nbsp;set,&nbsp;videoURL&nbsp;should&nbsp;not&nbsp;be&nbsp;set.<br>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Creative&nbsp;serving&nbsp;status.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"buyerCreativeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;buyer-specific&nbsp;id&nbsp;identifying&nbsp;the&nbsp;creative&nbsp;in&nbsp;this&nbsp;ad.<br>
181&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clickThroughUrl":&nbsp;[&nbsp;#&nbsp;The&nbsp;set&nbsp;of&nbsp;destination&nbsp;urls&nbsp;for&nbsp;the&nbsp;snippet.<br>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vendorType":&nbsp;[&nbsp;#&nbsp;All&nbsp;vendor&nbsp;types&nbsp;for&nbsp;the&nbsp;ads&nbsp;that&nbsp;may&nbsp;be&nbsp;shown&nbsp;from&nbsp;this&nbsp;snippet.<br>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disapprovalReasons":&nbsp;[&nbsp;#&nbsp;The&nbsp;reason&nbsp;for&nbsp;disapproval,&nbsp;if&nbsp;any.&nbsp;Note&nbsp;that&nbsp;not&nbsp;all&nbsp;disapproval&nbsp;reasons&nbsp;may&nbsp;be&nbsp;categorized,&nbsp;so&nbsp;it&nbsp;is&nbsp;possible&nbsp;for&nbsp;the&nbsp;creative&nbsp;to&nbsp;have&nbsp;a&nbsp;status&nbsp;of&nbsp;DISAPPROVED&nbsp;with&nbsp;an&nbsp;empty&nbsp;list&nbsp;for&nbsp;disapproval_reasons.&nbsp;In&nbsp;this&nbsp;case,&nbsp;please&nbsp;reach&nbsp;out&nbsp;to&nbsp;your&nbsp;TAM&nbsp;to&nbsp;help&nbsp;debug&nbsp;the&nbsp;issue.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sensitiveCategories":&nbsp;[&nbsp;#&nbsp;Detected&nbsp;sensitive&nbsp;categories,&nbsp;if&nbsp;any.&nbsp;Read-only.&nbsp;This&nbsp;field&nbsp;should&nbsp;not&nbsp;be&nbsp;set&nbsp;in&nbsp;requests.<br>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;42,<br>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;42,&nbsp;#&nbsp;Account&nbsp;id.<br>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
195&nbsp;&nbsp;&nbsp;&nbsp;],<br>
196&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"adexchangebuyer#creativesList",&nbsp;#&nbsp;Resource&nbsp;type.<br>
197&nbsp;&nbsp;}</tt></dd></dl>
198
Joe Gregorio41899542012-04-23 09:02:05 -0400[diff] [blame]199<hr>
200Data descriptors defined here:<br>
201<dl><dt><strong>__dict__</strong></dt>
202<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
203</dl>
204<dl><dt><strong>__weakref__</strong></dt>
205<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
206</dl>
207</td></tr></table>
208</body></html>