• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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
90      # LogUserEvent.
91    "lead": { # A lead resource that represents an advertiser contact for a `Company`. These # Advertiser lead information.
92        # are usually generated via Google Partner Search (the advertiser portal).
93      "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails
94      "languageCode": "A String", # Language code of the lead's language preference, as defined by
95          # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
96          # (IETF BCP 47, "Tags for Identifying Languages").
97      "type": "A String", # Type of lead.
98      "familyName": "A String", # Last name of lead source.
99      "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
100        "nanos": 42, # Number of nano (10^-9) units of the amount.
101            # The value must be between -999,999,999 and +999,999,999 inclusive.
102            # If `units` is positive, `nanos` must be positive or zero.
103            # If `units` is zero, `nanos` can be positive, zero, or negative.
104            # If `units` is negative, `nanos` must be negative or zero.
105            # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
106        "units": "A String", # The whole units of the amount.
107            # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
108        "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
109      },
110      "comments": "A String", # Comments lead source gave.
111      "createTime": "A String", # Timestamp of when this lead was created.
112      "websiteUrl": "A String", # Website URL of lead source.
113      "email": "A String", # Email address of lead source.
114      "state": "A String", # The lead's state in relation to the company.
115      "phoneNumber": "A String", # Phone number of lead source.
116      "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
117        "A String",
118      ],
119      "givenName": "A String", # First name of lead source.
120      "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
121      "id": "A String", # ID of the lead.
122    },
123    "url": "A String", # The URL where the event occurred.
124    "eventDatas": [ # List of event data for the event.
125      { # Key value data pair for an event.
126        "values": [ # Data values.
127          "A String",
128        ],
129        "key": "A String", # Data type.
130      },
131    ],
132    "eventCategory": "A String", # The category the action belongs to.
133    "eventAction": "A String", # The action that occurred.
134    "requestMetadata": { # Common data that is in each API request. # Current request metadata.
135      "locale": "A String", # Locale to use for the current request.
136      "partnersSessionId": "A String", # Google Partners session ID.
137      "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
138        "trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from.
139            # An identifier has multiple letters created by a team which redirected the
140            # traffic to us.
141        "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from.
142            # An identifier has multiple letters created by a team which redirected the
143            # traffic to us.
144      },
145      "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
146          # request. These are only honored by whitelisted products.
147          # honored by whitelisted products.
148        "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
149        "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
150      },
151      "experimentIds": [ # Experiment IDs the current request belongs to.
152        "A String",
153      ],
154    },
155    "eventScope": "A String", # The scope of the event.
156  }
157
158  x__xgafv: string, V1 error format.
159    Allowed values
160      1 - v1 error format
161      2 - v2 error format
162
163Returns:
164  An object of the form:
165
166    { # Response message for
167      # LogUserEvent.
168    "responseMetadata": { # Common data that is in each API response. # Current response metadata.
169      "debugInfo": { # Debug information about this request. # Debug information about this request.
170        "serverTraceInfo": "A String", # Server-side debug stack trace.
171        "serviceUrl": "A String", # URL of the service that handled this request.
172        "serverInfo": "A String", # Info about the server that serviced this request.
173      },
174    },
175  }</pre>
176</div>
177
178</body></html>