Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / gan_v1beta1.publishers.html
blob: 5d6a7418b36fa71dd09214b66c8570a9a1e7e318 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gan_v1beta1.html">Google Affiliate Network API</a> . <a href="gan_v1beta1.publishers.html">publishers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(role, roleId, publisherId=None)</a></code></p>
79<p class="firstline">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.</p>
80<p class="toc_element">
81 <code><a href="#list">list(role, roleId, publisherCategory=None, relationshipStatus=None, pageToken=None, minSevenDayEpc=None, minNinetyDayEpc=None, maxResults=None, minPayoutRank=None)</a></code></p>
82<p class="firstline">Retrieves data about all publishers that the requesting advertiser/publisher has access to.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(role, roleId, publisherId=None)</code>
89 <pre>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.
90
91Args:
92 role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
93 Allowed values
94 advertisers - The requester is requesting as an advertiser.
95 publishers - The requester is requesting as a publisher.
96 roleId: string, The ID of the requesting advertiser or publisher. (required)
97 publisherId: string, The ID of the publisher to look up. Optional.
98
99Returns:
100 An object of the form:
101
102 { # A PublisherResource.
103 "status": "A String", # The status of the requesting advertiser's relationship with this publisher.
104 "kind": "gan#publisher", # The kind for a publisher.
105 "name": "A String", # The name of this publisher.
106 "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
107 "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.
108 "amount": 3.14, # The amount of money.
109 "currencyCode": "A String", # The 3-letter code of the currency in question.
110 },
111 "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).
112 "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.
113 "amount": 3.14, # The amount of money.
114 "currencyCode": "A String", # The 3-letter code of the currency in question.
115 },
116 "item": # Object with schema name: Publisher # The requested publisher.
117 "joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
118 "sites": [ # Websites that this publisher uses to advertise.
119 "A String",
120 ],
121 "id": "A String", # The ID of this publisher.
122 }</pre>
123</div>
124
125<div class="method">
126 <code class="details" id="list">list(role, roleId, publisherCategory=None, relationshipStatus=None, pageToken=None, minSevenDayEpc=None, minNinetyDayEpc=None, maxResults=None, minPayoutRank=None)</code>
127 <pre>Retrieves data about all publishers that the requesting advertiser/publisher has access to.
128
129Args:
130 role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
131 Allowed values
132 advertisers - The requester is requesting as an advertiser.
133 publishers - The requester is requesting as a publisher.
134 roleId: string, The ID of the requesting advertiser or publisher. (required)
135 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.
136 relationshipStatus: string, Filters out all publishers for which do not have the given relationship status with the requesting publisher.
137 Allowed values
138 approved - Publishers you've approved to your program.
139 available - Publishers available for you to recruit.
140 deactivated - A publisher that you terminated from your program. Publishers also have the ability to remove themselves from your program.
141 declined - A publisher that you did not approve to your program.
142 pending - Publishers that have applied to your program. We recommend reviewing and deciding on pending publishers on a weekly basis.
143 pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
144 minSevenDayEpc: number, Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.
145 minNinetyDayEpc: number, Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
146 maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
147 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.
148
149Returns:
150 An object of the form:
151
152 {
153 "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
154 "items": [ # The entity list.
155 { # A PublisherResource.
156 "status": "A String", # The status of the requesting advertiser's relationship with this publisher.
157 "kind": "gan#publisher", # The kind for a publisher.
158 "name": "A String", # The name of this publisher.
159 "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
160 "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.
161 "amount": 3.14, # The amount of money.
162 "currencyCode": "A String", # The 3-letter code of the currency in question.
163 },
164 "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).
165 "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.
166 "amount": 3.14, # The amount of money.
167 "currencyCode": "A String", # The 3-letter code of the currency in question.
168 },
169 "item": # Object with schema name: Publisher # The requested publisher.
170 "joinDate": "A String", # Date that this publisher was approved as a Google Affiliate Network publisher.
171 "sites": [ # Websites that this publisher uses to advertise.
172 "A String",
173 ],
174 "id": "A String", # The ID of this publisher.
175 },
176 ],
177 "kind": "gan#publishers", # The kind for a page of entities.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
183 <pre>Retrieves the next page of results.
184
185Args:
186 previous_request: The request for the previous page. (required)
187 previous_response: The response from the request for the previous page. (required)
188
189Returns:
190 A request object that you can call 'execute()' on to request the next
191 page. Returns None if there are no more items in the collection.
192 </pre>
193</div>
194
195</body></html>