Class: Aws::Pinpoint::Types::SegmentGroupList

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::SegmentGroupList

show all

Defined in:: gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  groups: [
    {
      dimensions: [
        {
          attributes: {
            "__string" => {
              attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
              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, CONTAINS, BEFORE, AFTER, BETWEEN, ON
              values: ["__string"], # required
            },
          },
        },
      ],
      source_segments: [
        {
          id: "__string", # required
          version: 1,
        },
      ],
      source_type: "ALL", # accepts ALL, ANY, NONE
      type: "ALL", # accepts ALL, ANY, NONE
    },
  ],
  include: "ALL", # accepts ALL, ANY, NONE
}

Specifies the settings that define the relationships between segment groups for a segment.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#groups ⇒ Array<Types::SegmentGroup>
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
#include ⇒ String
Specifies how to handle multiple segment groups for the segment.

Instance Attribute Details

#groups ⇒ `Array<Types::SegmentGroup>`

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

Returns:

(Array<Types::SegmentGroup>)

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

class SegmentGroupList < Struct.new(
  :groups,
  :include)
  SENSITIVE = []
  include Aws::Structure
end

#include ⇒ `String`

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