Class: Aws::Pinpoint::Types::SegmentDimensions

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::SegmentDimensions

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  attributes: {
    "__string" => {
      attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
  },
  behavior: {
    recency: {
      duration: "HR_24", # required, accepts HR_24, DAY_7, DAY_14, DAY_30
      recency_type: "ACTIVE", # required, accepts ACTIVE, INACTIVE
    },
  },
  demographic: {
    app_version: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    channel: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    device_type: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    make: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    model: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    platform: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
  },
  location: {
    country: {
      dimension_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
    gps_point: {
      coordinates: { # required
        latitude: 1.0, # required
        longitude: 1.0, # required
      },
      range_in_kilometers: 1.0,
    },
  },
  metrics: {
    "__string" => {
      comparison_operator: "__string", # required
      value: 1.0, # required
    },
  },
  user_attributes: {
    "__string" => {
      attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE
      values: ["__string"], # required
    },
  },
}

Specifies the dimension settings for a segment.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,Types::AttributeDimension>

  One or more custom attributes to use as criteria for the segment.

• #behavior ⇒ Types::SegmentBehaviors

  The behavior-based criteria, such as how recently users have used your app, for the segment.

• #demographic ⇒ Types::SegmentDemographics

  The demographic-based criteria, such as device platform, for the segment.

• #location ⇒ Types::SegmentLocation

  The location-based criteria, such as region or GPS coordinates, for the segment.

• #metrics ⇒ Hash<String,Types::MetricDimension>

  One or more custom metrics to use as criteria for the segment.

• #user_attributes ⇒ Hash<String,Types::AttributeDimension>

  One or more custom user attributes to use as criteria for the segment.

Instance Attribute Details

#attributes ⇒ Hash<String,Types::AttributeDimension>

One or more custom attributes to use as criteria for the segment.

Returns:

• (Hash<String,Types::AttributeDimension>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14083

class SegmentDimensions < Struct.new(
  :attributes,
  :behavior,
  :demographic,
  :location,
  :metrics,
  :user_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#behavior ⇒ Types::SegmentBehaviors

The behavior-based criteria, such as how recently users have used your app, for the segment.

Returns:

• (Types::SegmentBehaviors)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14083

class SegmentDimensions < Struct.new(
  :attributes,
  :behavior,
  :demographic,
  :location,
  :metrics,
  :user_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#demographic ⇒ Types::SegmentDemographics

The demographic-based criteria, such as device platform, for the segment.

Returns:

• (Types::SegmentDemographics)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14083

class SegmentDimensions < Struct.new(
  :attributes,
  :behavior,
  :demographic,
  :location,
  :metrics,
  :user_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::SegmentLocation

The location-based criteria, such as region or GPS coordinates, for the segment.

Returns:

• (Types::SegmentLocation)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14083

class SegmentDimensions < Struct.new(
  :attributes,
  :behavior,
  :demographic,
  :location,
  :metrics,
  :user_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Hash<String,Types::MetricDimension>

One or more custom metrics to use as criteria for the segment.

Returns:

• (Hash<String,Types::MetricDimension>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14083

class SegmentDimensions < Struct.new(
  :attributes,
  :behavior,
  :demographic,
  :location,
  :metrics,
  :user_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#user_attributes ⇒ Hash<String,Types::AttributeDimension>

One or more custom user attributes to use as criteria for the segment.

Returns:

• (Hash<String,Types::AttributeDimension>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 14083

class SegmentDimensions < Struct.new(
  :attributes,
  :behavior,
  :demographic,
  :location,
  :metrics,
  :user_attributes)
  SENSITIVE = []
  include Aws::Structure
end