132 lines
18 KiB
HTML
132 lines
18 KiB
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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about a single advertiser if that the requesting advertiser/publisher has access to it. Only publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.<br>
|
|
<br>
|
|
Args:<br>
|
|
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
|
advertiserId: string, The ID of the advertiser to look up. Optional.<br>
|
|
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
|
Allowed values<br>
|
|
advertisers - The requester is requesting as an advertiser.<br>
|
|
publishers - The requester is requesting as a publisher.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{ # An AdvertiserResource.<br>
|
|
"category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a><br>
|
|
"productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.<br>
|
|
"kind": "gan#advertiser", # The kind for an advertiser. The kind for one entity.<br>
|
|
"siteUrl": "A String", # URL of the website this advertiser advertises from.<br>
|
|
"contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.<br>
|
|
"description": "A String", # Description of the website the advertiser advertises from.<br>
|
|
"payoutRank": "A String", # A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).<br>
|
|
"epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.<br>
|
|
"amount": 3.14, # The amount of money.<br>
|
|
"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
|
|
},<br>
|
|
"commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).<br>
|
|
"status": "A String", # The status of the requesting publisher's relationship this advertiser.<br>
|
|
"epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.<br>
|
|
"amount": 3.14, # The amount of money.<br>
|
|
"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
|
|
},<br>
|
|
"contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.<br>
|
|
"item": # Object with schema name: Advertiser # The requested advertiser.<br>
|
|
"joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.<br>
|
|
"logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.<br>
|
|
"id": "A String", # The ID of this advertiser.<br>
|
|
"name": "A String", # The name of this advertiser.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about all advertisers that the requesting advertiser/publisher has access to.<br>
|
|
<br>
|
|
Args:<br>
|
|
relationshipStatus: string, Filters out all advertisers for which do not have the given relationship status with the requesting publisher.<br>
|
|
Allowed values<br>
|
|
approved - An advertiser that has approved your application.<br>
|
|
available - An advertiser program that's accepting new publishers.<br>
|
|
deactivated - Deactivated means either the advertiser has removed you from their program, or it could also mean that you chose to remove yourself from the advertiser's program.<br>
|
|
declined - An advertiser that did not approve your application.<br>
|
|
pending - An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.<br>
|
|
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
|
minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
|
advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a>. Filters out all advertisers not in one of the given advertiser categories. Optional.<br>
|
|
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
|
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)<br>
|
|
Allowed values<br>
|
|
advertisers - The requester is requesting as an advertiser.<br>
|
|
publishers - The requester is requesting as a publisher.<br>
|
|
maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.<br>
|
|
minSevenDayEpc: number, Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
|
minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.<br>
|
|
"items": [ # The advertiser list.<br>
|
|
{ # An AdvertiserResource.<br>
|
|
"category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581</a><br>
|
|
"productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.<br>
|
|
"kind": "gan#advertiser", # The kind for an advertiser. The kind for one entity.<br>
|
|
"siteUrl": "A String", # URL of the website this advertiser advertises from.<br>
|
|
"contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.<br>
|
|
"description": "A String", # Description of the website the advertiser advertises from.<br>
|
|
"payoutRank": "A String", # A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).<br>
|
|
"epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.<br>
|
|
"amount": 3.14, # The amount of money.<br>
|
|
"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
|
|
},<br>
|
|
"commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).<br>
|
|
"status": "A String", # The status of the requesting publisher's relationship this advertiser.<br>
|
|
"epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.<br>
|
|
"amount": 3.14, # The amount of money.<br>
|
|
"currencyCode": "A String", # The 3-letter code of the currency in question.<br>
|
|
},<br>
|
|
"contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.<br>
|
|
"item": # Object with schema name: Advertiser # The requested advertiser.<br>
|
|
"joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.<br>
|
|
"logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.<br>
|
|
"id": "A String", # The ID of this advertiser.<br>
|
|
"name": "A String", # The name of this advertiser.<br>
|
|
},<br>
|
|
],<br>
|
|
"kind": "gan#advertisers", # The kind for a page of advertisers.<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> |