Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0b723c21611ef6d3c821029715ef27ba56b6943e / . / docs / dyn / gan_v1beta1.advertisers.html
blob: 6818be536c2e68e6c0ee23d9d5d114ff449c322b [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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.advertisers.html">advertisers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(role, roleId, advertiserId=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 publishers can lookup advertisers. Advertisers can request information about themselves by omitting the advertiserId query parameter.</p>
80<p class="toc_element">
81 <code><a href="#list">list(role, roleId, relationshipStatus=None, pageToken=None, advertiserCategory=None, minNinetyDayEpc=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</a></code></p>
82<p class="firstline">Retrieves data about all advertisers 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, advertiserId=None)</code>
89 <pre>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.
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 advertiserId: string, The ID of the advertiser to look up. Optional.
98
99Returns:
100 An object of the form:
101
102 { # An AdvertiserResource.
103 "category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
104 "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
105 "kind": "gan#advertiser", # The kind for an advertiser.
106 "siteUrl": "A String", # URL of the website this advertiser advertises from.
107 "contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.
108 "description": "A String", # Description of the website the advertiser advertises from.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]109 "merchantCenterIds": [ # List of merchant center ids for this advertiser
110 "A String",
111 ],
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]112 "defaultLinkId": "A String", # The default link id for this advertiser.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]113 "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]114 "amount": 3.14, # The amount of money.
115 "currencyCode": "A String", # The 3-letter code of the currency in question.
116 },
117 "commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
118 "status": "A String", # The status of the requesting publisher's relationship this advertiser.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]119 "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).
120 "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]121 "amount": 3.14, # The amount of money.
122 "currencyCode": "A String", # The 3-letter code of the currency in question.
123 },
124 "allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.
125 "item": # Object with schema name: Advertiser # The requested advertiser.
126 "joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.
127 "logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]128 "redirectDomains": [ # List of redirect URLs for this advertiser
129 "A String",
130 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]131 "id": "A String", # The ID of this advertiser.
132 "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
133 "name": "A String", # The name of this advertiser.
134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="list">list(role, roleId, relationshipStatus=None, pageToken=None, advertiserCategory=None, minNinetyDayEpc=None, maxResults=None, minSevenDayEpc=None, minPayoutRank=None)</code>
139 <pre>Retrieves data about all advertisers that the requesting advertiser/publisher has access to.
140
141Args:
142 role: string, The role of the requester. Valid values: 'advertisers' or 'publishers'. (required)
143 Allowed values
144 advertisers - The requester is requesting as an advertiser.
145 publishers - The requester is requesting as a publisher.
146 roleId: string, The ID of the requesting advertiser or publisher. (required)
147 relationshipStatus: string, Filters out all advertisers for which do not have the given relationship status with the requesting publisher.
148 Allowed values
149 approved - An advertiser that has approved your application.
150 available - An advertiser program that's accepting new publishers.
151 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.
152 declined - An advertiser that did not approve your application.
153 pending - An advertiser program that you've already applied to, but they haven't yet decided to approve or decline your application.
154 pageToken: string, The value of 'nextPageToken' from the previous page. Optional.
155 advertiserCategory: string, Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
156 minNinetyDayEpc: number, Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
157 maxResults: integer, Max number of items to return in this page. Optional. Defaults to 20.
158 minSevenDayEpc: number, Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
159 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.
160
161Returns:
162 An object of the form:
163
164 {
165 "nextPageToken": "A String", # The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
166 "items": [ # The advertiser list.
167 { # An AdvertiserResource.
168 "category": "A String", # Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
169 "contactEmail": "A String", # Email that this advertiser would like publishers to contact them with.
170 "kind": "gan#advertiser", # The kind for an advertiser.
171 "siteUrl": "A String", # URL of the website this advertiser advertises from.
172 "contactPhone": "A String", # Phone that this advertiser would like publishers to contact them with.
173 "description": "A String", # Description of the website the advertiser advertises from.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]174 "merchantCenterIds": [ # List of merchant center ids for this advertiser
175 "A String",
176 ],
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]177 "defaultLinkId": "A String", # The default link id for this advertiser.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]178 "epcSevenDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]179 "amount": 3.14, # The amount of money.
180 "currencyCode": "A String", # The 3-letter code of the currency in question.
181 },
182 "commissionDuration": 42, # The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
183 "status": "A String", # The status of the requesting publisher's relationship this advertiser.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]184 "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).
185 "epcNinetyDayAverage": { # An ApiMoneyProto. # The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]186 "amount": 3.14, # The amount of money.
187 "currencyCode": "A String", # The 3-letter code of the currency in question.
188 },
189 "allowPublisherCreatedLinks": True or False, # True if the advertiser allows publisher created links, otherwise false.
190 "item": # Object with schema name: Advertiser # The requested advertiser.
191 "joinDate": "A String", # Date that this advertiser was approved as a Google Affiliate Network advertiser.
192 "logoUrl": "A String", # URL to the logo this advertiser uses on the Google Affiliate Network.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500[diff] [blame]193 "redirectDomains": [ # List of redirect URLs for this advertiser
194 "A String",
195 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]196 "id": "A String", # The ID of this advertiser.
197 "productFeedsEnabled": True or False, # Allows advertisers to submit product listings to Google Product Search.
198 "name": "A String", # The name of this advertiser.
199 },
200 ],
201 "kind": "gan#advertisers", # The kind for a page of advertisers.
202 }</pre>
203</div>
204
205<div class="method">
206 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
207 <pre>Retrieves the next page of results.
208
209Args:
210 previous_request: The request for the previous page. (required)
211 previous_response: The response from the request for the previous page. (required)
212
213Returns:
214 A request object that you can call 'execute()' on to request the next
215 page. Returns None if there are no more items in the collection.
216 </pre>
217</div>
218
219</body></html>