Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / partners_v2.offers.html
blob: 6790ab15945e18e75b836908224c2d8914db96a6 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -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="partners_v2.html">Google Partners API</a> . <a href="partners_v2.offers.html">offers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="partners_v2.offers.history.html">history()</a></code>
79</p>
80<p class="firstline">Returns the history Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#list">list(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
84<p class="firstline">Lists the Offers available for the current user</p>
85<h3>Method Details</h3>
86<div class="method">
87 <code class="details" id="list">list(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
88 <pre>Lists the Offers available for the current user
89
90Args:
91 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
92 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
93An identifier has multiple letters created by a team which redirected the
94traffic to us.
95 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
100 requestMetadata_locale: string, Locale to use for the current request.
101 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
102 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
103An identifier has multiple letters created by a team which redirected the
104traffic to us.
105 requestMetadata_partnersSessionId: string, Google Partners session ID.
106
107Returns:
108 An object of the form:
109
110 { # Response for ListOffer.
111 "noOfferReason": "A String", # Reason why no Offers are available.
112 "availableOffers": [ # Available Offers to be distributed.
113 { # Available Offers to be distributed.
114 "available": 42, # The number of codes for this offer that are available for distribution.
115 "countryOfferInfos": [ # Offer info by country.
116 { # Offer info by country.
117 "spendXAmount": "A String", # (localized) Spend X amount for that country's offer.
118 "offerType": "A String", # Type of offer country is eligible for.
119 "offerCountryCode": "A String", # Country code for which offer codes may be requested.
120 "getYAmount": "A String", # (localized) Get Y amount for that country's offer.
121 },
122 ],
123 "qualifiedCustomer": [ # Customers who qualify for this offer.
124 { # Customers qualified for an offer.
125 "name": "A String", # Name of the customer.
126 "countryCode": "A String", # Country code of the customer.
127 "spendXAmount": "A String", # Formatted Spend X amount with currency code.
128 "adwordsUrl": "A String", # URL to the customer's AdWords page.
129 "creationTime": "A String", # Time the customer was created.
130 "externalCid": "A String", # External CID for the customer.
131 "eligibilityDaysLeft": 42, # Days the customer is still eligible.
132 "getYAmount": "A String", # Formatted Get Y amount with currency code.
133 "offerType": "A String", # Type of the offer
134 },
135 ],
136 "terms": "A String", # Terms of the offer.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]137 "name": "A String", # Name of the offer.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 "maxAccountAge": 42, # The maximum age of an account [in days] to be eligible.
139 "offerLevel": "A String", # Level of this offer.
140 "showSpecialOfferCopy": True or False, # Should special text be shown on the offers page.
141 "offerType": "A String", # Type of offer.
142 "id": "A String", # ID of this offer.
143 "qualifiedCustomersComplete": True or False, # Whether or not the list of qualified customers is definitely complete.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]144 "description": "A String", # Description of the offer.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]145 },
146 ],
147 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
148 "debugInfo": { # Debug information about this request. # Debug information about this request.
149 "serverTraceInfo": "A String", # Server-side debug stack trace.
150 "serviceUrl": "A String", # URL of the service that handled this request.
151 "serverInfo": "A String", # Info about the server that serviced this request.
152 },
153 },
154 }</pre>
155</div>
156
157</body></html>