| |
| <!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> |