132 lines
16 KiB
HTML
132 lines
16 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 advertisers can look up publishers. Publishers can request information about themselves by omitting the publisherId query parameter.<br>
|
|
<br>
|
|
Args:<br>
|
|
pp: string, A parameter<br>
|
|
trace: string, A parameter<br>
|
|
strict: string, A parameter<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>
|
|
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
|
userip: string, A parameter<br>
|
|
publisherId: string, The ID of the publisher to look up. Optional.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{ # A PublisherResource.<br>
|
|
"status": "A String", # The status of the requesting advertiser's relationship with this publisher.<br>
|
|
"kind": "gan#publisher", # The kind for a publisher.<br>
|
|
"name": "A String", # The name of this publisher.<br>
|
|
"classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4</a><br>
|
|
"epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher 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>
|
|
"payoutRank": "A String", # A rank based on commissions paid to this publisher 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>
|
|
"epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher 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>
|
|
"item": # Object with schema name: Publisher # The requested publisher.<br>
|
|
"joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.<br>
|
|
"sites": [ # Websites that this publisher uses to advertise.<br>
|
|
"A String",<br>
|
|
],<br>
|
|
"id": "A String", # The ID of this publisher.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves data about all publishers that the requesting advertiser/publisher has access to.<br>
|
|
<br>
|
|
Args:<br>
|
|
publisherCategory: string, Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional.<br>
|
|
relationshipStatus: string, Filters out all publishers for which do not have the given relationship status with the requesting publisher.<br>
|
|
Allowed values<br>
|
|
approved - Publishers you've approved to your program.<br>
|
|
available - Publishers available for you to recruit.<br>
|
|
deactivated - A publisher that you terminated from your program. Publishers also have the ability to remove themselves from your program.<br>
|
|
declined - A publisher that you did not approve to your program.<br>
|
|
pending - Publishers that have applied to your program. We recommend reviewing and deciding on pending publishers on a weekly basis.<br>
|
|
trace: string, A parameter<br>
|
|
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.<br>
|
|
minSevenDayEpc: number, Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.<br>
|
|
roleId: string, The ID of the requesting advertiser or publisher. (required)<br>
|
|
pp: string, A parameter<br>
|
|
minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.<br>
|
|
strict: string, A parameter<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>
|
|
userip: string, A parameter<br>
|
|
minPayoutRank: integer, A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers 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 entity list.<br>
|
|
{ # A PublisherResource.<br>
|
|
"status": "A String", # The status of the requesting advertiser's relationship with this publisher.<br>
|
|
"kind": "gan#publisher", # The kind for a publisher.<br>
|
|
"name": "A String", # The name of this publisher.<br>
|
|
"classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: <a href="http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4">http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4</a><br>
|
|
"epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher 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>
|
|
"payoutRank": "A String", # A rank based on commissions paid to this publisher 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>
|
|
"epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to this publisher 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>
|
|
"item": # Object with schema name: Publisher # The requested publisher.<br>
|
|
"joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.<br>
|
|
"sites": [ # Websites that this publisher uses to advertise.<br>
|
|
"A String",<br>
|
|
],<br>
|
|
"id": "A String", # The ID of this publisher.<br>
|
|
},<br>
|
|
],<br>
|
|
"kind": "gan#publishers", # The kind for a page of entities.<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> |