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

Class: Aws::Pinpoint::Types::SegmentGroup

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

Overview

Note:

When passing SegmentGroup as input to an Aws::Client method, you can use a vanilla Hash:

{
  dimensions: [
    {
      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
        },
      },
    },
  ],
  source_segments: [
    {
      id: "__string", # required
      version: 1,
    },
  ],
  source_type: "ALL", # accepts ALL, ANY, NONE
  type: "ALL", # accepts ALL, ANY, NONE
}

Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dimensions ⇒ Array<Types::SegmentDimensions>

An array that defines the dimensions for the segment.

Returns:

#source_segments ⇒ Array<Types::SegmentReference>

The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

Returns:

#source_type ⇒ String

Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

Possible values:

  • ALL
  • ANY
  • NONE

Returns:

  • (String) —

    Specifies how to handle multiple base segments for the segment.

#type ⇒ String

Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Possible values:

  • ALL
  • ANY
  • NONE

Returns:

  • (String) —

    Specifies how to handle multiple dimensions for the segment.