AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SegmentDimensions as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,Types::AttributeDimension>

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

Returns:

#behaviorTypes::SegmentBehaviors

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

Returns:

  • (Types::SegmentBehaviors)

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

#demographicTypes::SegmentDemographics

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

Returns:

#locationTypes::SegmentLocation

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

Returns:

  • (Types::SegmentLocation)

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

#metricsHash<String,Types::MetricDimension>

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

Returns:

#user_attributesHash<String,Types::AttributeDimension>

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

Returns: