Logs a user event.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

LogUserEventRequest:
  event-action: string
  event-category: string
  event-scope: string
  lead:
    adwords-customer-id: string
    comments: string
    create-time: string
    email: string
    family-name: string
    given-name: string
    gps-motivations: [string]
    id: string
    language-code: string
    marketing-opt-in: boolean
    min-monthly-budget:
      currency-code: string
      nanos: integer
      units: string
    phone-number: string
    state: string
    type: string
    website-url: string
  request-metadata:
    experiment-ids: [string]
    locale: string
    partners-session-id: string
    traffic-source:
      traffic-source-id: string
      traffic-sub-id: string
    user-overrides:
      ip-address: string
      user-id: string
  url: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

-r . event-action=voluptua.
- The action that occurred.
event-category=dolore
- The category the action belongs to.
event-scope=dolore
- The scope of the event.
lead adwords-customer-id=dolore
- The AdWords Customer ID of the lead.
comments=voluptua.
- Comments lead source gave.
create-time=amet.
- Timestamp of when this lead was created.
email=ea
- Email address of lead source.
family-name=sadipscing
- Last name of lead source.
given-name=lorem
- First name of lead source.
gps-motivations=invidunt
- List of reasons for using Google Partner Search and creating a lead.
- Each invocation of this argument appends the given value to the array.
id=no
- ID of the lead.
language-code=est
- Language code of the lead's language preference, as defined by <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> (IETF BCP 47, "Tags for Identifying Languages").
marketing-opt-in=true
- Whether or not the lead signed up for marketing emails
min-monthly-budget currency-code=sit
- The 3-letter currency code defined in ISO 4217.
nanos=66
- 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.
units=tempor
- The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
.. phone-number=aliquyam
- Phone number of lead source.
state=ipsum
- The lead's state in relation to the company.
type=et
- Type of lead.
website-url=sanctus
- Website URL of lead source.
..request-metadata experiment-ids=lorem
- Experiment IDs the current request belongs to.
- Each invocation of this argument appends the given value to the array.
locale=est
- Locale to use for the current request.
partners-session-id=sed
- Google Partners session ID.
traffic-source traffic-source-id=diam
- Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
traffic-sub-id=dolores
- 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.
..user-overrides ip-address=dolores
- IP address to use instead of the user's geo-located IP address.
user-id=et
- Logged-in user ID to impersonate instead of the user's ID.
... url=sed
- The URL where the event occurred.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

-o out
- out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

-p $-xgafv=string
- V1 error format.
-p access-token=string
- OAuth access token.
-p alt=string
- Data format for response.
-p callback=string
- JSONP
-p fields=string
- Selector specifying which fields to include in a partial response.
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-p oauth-token=string
- OAuth 2.0 token for the current user.
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").