Class: Aws::Pinpoint::Types::Event

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass Event data as a hash:

{
  app_package_name: "__string",
  app_title: "__string",
  app_version_code: "__string",
  attributes: {
    "__string" => "__string",
  },
  client_sdk_version: "__string",
  event_type: "__string", # required
  metrics: {
    "__string" => 1.0,
  },
  sdk_name: "__string",
  session: {
    duration: 1,
    id: "__string", # required
    start_timestamp: "__string", # required
    stop_timestamp: "__string",
  },
  timestamp: "__string", # required
}

Specifies information about an event that reports data to Amazon Pinpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_package_nameString

The package name of the app that's recording the event.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#app_titleString

The title of the app that's recording the event.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#app_version_codeString

The version number of the app that's recording the event.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#attributesHash<String,String>

One or more custom attributes that are associated with the event.

Returns:

  • (Hash<String,String>)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#client_sdk_versionString

The version of the SDK that's running on the client device.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#event_typeString

The name of the event.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#metricsHash<String,Float>

One or more custom metrics that are associated with the event.

Returns:

  • (Hash<String,Float>)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#sdk_nameString

The name of the SDK that's being used to record the event.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#sessionTypes::Session

Information about the session in which the event occurred.

Returns:



7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#timestampString

The date and time, in ISO 8601 format, when the event occurred.

Returns:

  • (String)


7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7357

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end