Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / partners_v2.userEvents.html
blob: 99ff4153807fbd58ce3c6fe640b215404a6f3b48 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[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.userEvents.html">userEvents</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#log">log(body, x__xgafv=None)</a></code></p>
79<p class="firstline">Logs a user event.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="log">log(body, x__xgafv=None)</code>
83 <pre>Logs a user event.
84
85Args:
86 body: object, The request body. (required)
87 The object takes the form of:
88
89{ # Request message for [LogUserEvent][google.partners.v2.ClientAuditor.LogUserEvent].
90 "lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # Advertiser lead information.
91 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
92 "A String",
93 ],
94 "familyName": "A String", # Last name of lead source.
95 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
96 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
97 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
98 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
99 },
100 "comments": "A String", # Comments lead source gave.
101 "email": "A String", # Email address of lead source.
102 "websiteUrl": "A String", # Website URL of lead source.
103 "phoneNumber": "A String", # Phone number of lead source.
104 "givenName": "A String", # First name of lead source.
105 "type": "A String", # Type of lead.
106 "id": "A String", # ID of the lead.
107 },
108 "url": "A String", # The URL where the event occurred.
109 "eventDatas": [ # List of event data for the event.
110 { # Key value data pair for an event.
111 "values": [ # Data values.
112 "A String",
113 ],
114 "key": "A String", # Data type.
115 },
116 ],
117 "eventAction": "A String", # The action that occurred.
118 "eventCategory": "A String", # The category the action belongs to.
119 "requestMetadata": { # Common data that is in each API request. # Current request metadata.
120 "locale": "A String", # Locale to use for the current request.
121 "partnersSessionId": "A String", # Google Partners session ID.
122 "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
123 "trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
124 "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
125 },
126 "userOverrides": { # Values to use instead of the user's respective defaults. These are only honored by whitelisted products. # Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products.
127 "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
128 "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
129 },
130 "experimentIds": [ # Experiment IDs the current request belongs to.
131 "A String",
132 ],
133 },
134 "eventScope": "A String", # The scope of the event.
135 }
136
137 x__xgafv: string, V1 error format.
138
139Returns:
140 An object of the form:
141
142 { # Response message for [LogUserEvent][google.partners.v2.ClientAuditor.LogUserEvent].
143 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
144 "debugInfo": { # Debug information about this request. # Debug information about this request.
145 "serverTraceInfo": "A String", # Server-side debug stack trace.
146 "serviceUrl": "A String", # URL of the service that handled this request.
147 "serverInfo": "A String", # Info about the server that serviced this request.
148 },
149 },
150 }</pre>
151</div>
152
153</body></html>