| |
Methods defined here:
- __init__(self)
- get = method(self, **kwargs)
- 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.
Args:
pp: string, A parameter
trace: string, A parameter
strict: string, A parameter
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
Allowed values
advertisers - The requester is requesting as an advertiser.
publishers - The requester is requesting as a publisher.
roleId: string, The ID of the requesting advertiser or publisher. (required)
userip: string, A parameter
publisherId: string, The ID of the publisher to look up. Optional.
Returns:
An object of the form
{ # A PublisherResource.
"status": "A String", # The status of the requesting advertiser's relationship with this publisher.
"kind": "gan#publisher", # The kind for a publisher.
"name": "A String", # The name of this publisher.
"classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
"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.
"amount": 3.14, # The amount of money.
"currencyCode": "A String", # The 3-letter code of the currency in question.
},
"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).
"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.
"amount": 3.14, # The amount of money.
"currencyCode": "A String", # The 3-letter code of the currency in question.
},
"item": # Object with schema name: Publisher # The requested publisher.
"joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
"sites": [ # Websites that this publisher uses to advertise.
"A String",
],
"id": "A String", # The ID of this publisher.
}
- list = method(self, **kwargs)
- Retrieves data about all publishers that the requesting advertiser/publisher has access to.
Args:
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.
relationshipStatus: string, Filters out all publishers for which do not have the given relationship status with the requesting publisher.
Allowed values
approved - Publishers you've approved to your program.
available - Publishers available for you to recruit.
deactivated - A publisher that you terminated from your program. Publishers also have the ability to remove themselves from your program.
declined - A publisher that you did not approve to your program.
pending - Publishers that have applied to your program. We recommend reviewing and deciding on pending publishers on a weekly basis.
trace: string, A parameter
pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
minSevenDayEpc: number, Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.
roleId: string, The ID of the requesting advertiser or publisher. (required)
pp: string, A parameter
minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
strict: string, A parameter
role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
Allowed values
advertisers - The requester is requesting as an advertiser.
publishers - The requester is requesting as a publisher.
maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
userip: string, A parameter
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.
Returns:
An object of the form
{
"nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
"items": [ # The entity list.
{ # A PublisherResource.
"status": "A String", # The status of the requesting advertiser's relationship with this publisher.
"kind": "gan#publisher", # The kind for a publisher.
"name": "A String", # The name of this publisher.
"classification": "A String", # Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
"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.
"amount": 3.14, # The amount of money.
"currencyCode": "A String", # The 3-letter code of the currency in question.
},
"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).
"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.
"amount": 3.14, # The amount of money.
"currencyCode": "A String", # The 3-letter code of the currency in question.
},
"item": # Object with schema name: Publisher # The requested publisher.
"joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
"sites": [ # Websites that this publisher uses to advertise.
"A String",
],
"id": "A String", # The ID of this publisher.
},
],
"kind": "gan#publishers", # The kind for a page of entities.
}
- list_next = methodNext(self, previous_request, previous_response)
- Retrieves the next page of results.
Args:
previous_request: The request for the previous page.
previous_response: The response from the request for the previous page.
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|