blob: 3163914a69b41e664166c79db3a00ca085cdfaa4 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<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.userStates.html">userStates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <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>
79<p class="firstline">Lists states for current user.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <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>
83 <pre>Lists states for current user.
84
85Args:
86 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040087 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
88An identifier has multiple letters created by a team which redirected the
89traffic to us.
Takashi Matsuo06694102015-09-11 13:55:40 -070090 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
91 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040092 Allowed values
93 1 - v1 error format
94 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -070095 requestMetadata_locale: string, Locale to use for the current request.
96 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040097 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
98An identifier has multiple letters created by a team which redirected the
99traffic to us.
Takashi Matsuo06694102015-09-11 13:55:40 -0700100 requestMetadata_partnersSessionId: string, Google Partners session ID.
101
102Returns:
103 An object of the form:
104
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400105 { # Response message for
106 # ListUserStates.
Takashi Matsuo06694102015-09-11 13:55:40 -0700107 "userStates": [ # User's states.
108 "A String",
109 ],
110 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
111 "debugInfo": { # Debug information about this request. # Debug information about this request.
112 "serverTraceInfo": "A String", # Server-side debug stack trace.
113 "serviceUrl": "A String", # URL of the service that handled this request.
114 "serverInfo": "A String", # Info about the server that serviced this request.
115 },
116 },
117 }</pre>
118</div>
119
120</body></html>