Skip to content

/AWS1/IF_CUS=>CREATESEGMENTDEFINITION()

About CreateSegmentDefinition

Creates a segment definition associated to the given domain.

Method Signature

METHODS /AWS1/IF_CUS~CREATESEGMENTDEFINITION
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IV_SEGMENTDEFINITIONNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/CUSSTRING1TO255 OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/CUSSENSITIVETEXT OPTIONAL
    !IO_SEGMENTGROUPS TYPE REF TO /AWS1/CL_CUSSEGMENTGROUP OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CUSTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cuscresegmentdefnrsp
  RAISING
    /AWS1/CX_CUSACCESSDENIEDEX
    /AWS1/CX_CUSBADREQUESTEX
    /AWS1/CX_CUSINTERNALSERVEREX
    /AWS1/CX_CUSRESOURCENOTFOUNDEX
    /AWS1/CX_CUSTHROTTLINGEX
    /AWS1/CX_CUSCLIENTEXC
    /AWS1/CX_CUSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the domain.

iv_segmentdefinitionname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the segment definition.

iv_displayname TYPE /AWS1/CUSSTRING1TO255 /AWS1/CUSSTRING1TO255

The display name of the segment definition.

io_segmentgroups TYPE REF TO /AWS1/CL_CUSSEGMENTGROUP /AWS1/CL_CUSSEGMENTGROUP

Specifies the base segments and dimensions for a segment definition along with their respective relationship.

Optional arguments:

iv_description TYPE /AWS1/CUSSENSITIVETEXT /AWS1/CUSSENSITIVETEXT

The description of the segment definition.

it_tags TYPE /AWS1/CL_CUSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags used to organize, track, or control access for this resource.

RETURNING

oo_output TYPE REF TO /aws1/cl_cuscresegmentdefnrsp /AWS1/CL_CUSCRESEGMENTDEFNRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createsegmentdefinition(
  io_segmentgroups = new /aws1/cl_cussegmentgroup(
    it_groups = VALUE /aws1/cl_cusgroup=>tt_segmentgrouplist(
      (
        new /aws1/cl_cusgroup(
          it_dimensions = VALUE /aws1/cl_cusdimension=>tt_dimensionlist(
            (
              new /aws1/cl_cusdimension(
                io_profileattributes = new /aws1/cl_cusprofileattributes(
                  io_accountnumber = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_additionalinformation = new /aws1/cl_cusextralengthvalpf00(
                    it_values = VALUE /aws1/cl_cusextralengthvals_w=>tt_extralengthvalues(
                      ( new /aws1/cl_cusextralengthvals_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_address = new /aws1/cl_cusaddressdimension(
                    io_city = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_country = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_county = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_postalcode = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_province = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_state = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                  )
                  io_billingaddress = new /aws1/cl_cusaddressdimension(
                    io_city = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_country = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_county = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_postalcode = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_province = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_state = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                  )
                  io_birthdate = new /aws1/cl_cusdatedimension(
                    it_values = VALUE /aws1/cl_cusdatevalues_w=>tt_datevalues(
                      ( new /aws1/cl_cusdatevalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_businessemailaddress = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_businessname = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_businessphonenumber = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_emailaddress = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_firstname = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_genderstring = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_homephonenumber = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_lastname = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_mailingaddress = new /aws1/cl_cusaddressdimension(
                    io_city = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_country = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_county = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_postalcode = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_province = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_state = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                  )
                  io_middlename = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_mobilephonenumber = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_partytypestring = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_personalemailaddress = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_phonenumber = new /aws1/cl_cusprofiledimension(
                    it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                      ( new /aws1/cl_cusvalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_profiletype = new /aws1/cl_cuspfltypedimension(
                    it_values = VALUE /aws1/cl_cuspfltypevalues_w=>tt_profiletypevalues(
                      ( new /aws1/cl_cuspfltypevalues_w( |string| ) )
                    )
                    iv_dimensiontype = |string|
                  )
                  io_shippingaddress = new /aws1/cl_cusaddressdimension(
                    io_city = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_country = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_county = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_postalcode = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_province = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                    io_state = new /aws1/cl_cusprofiledimension(
                      it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                        ( new /aws1/cl_cusvalues_w( |string| ) )
                      )
                      iv_dimensiontype = |string|
                    )
                  )
                  it_attributes = VALUE /aws1/cl_cusattributedimension=>tt_customattributes(
                    (
                      VALUE /aws1/cl_cusattributedimension=>ts_customattributes_maprow(
                        value = new /aws1/cl_cusattributedimension(
                          it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                            ( new /aws1/cl_cusvalues_w( |string| ) )
                          )
                          iv_dimensiontype = |string|
                        )
                        key = |string|
                      )
                    )
                  )
                )
                it_calculatedattributes = VALUE /aws1/cl_cuscalculatedattrdi00=>tt_calculatedcustomattributes(
                  (
                    VALUE /aws1/cl_cuscalculatedattrdi00=>ts_calculatedcustattrs_maprow(
                      key = |string|
                      value = new /aws1/cl_cuscalculatedattrdi00(
                        io_conditionoverrides = new /aws1/cl_cusconditionoverrides(
                          io_range = new /aws1/cl_cusrangeoverride(
                            iv_end = 123
                            iv_start = 123
                            iv_unit = |string|
                          )
                        )
                        it_values = VALUE /aws1/cl_cusvalues_w=>tt_values(
                          ( new /aws1/cl_cusvalues_w( |string| ) )
                        )
                        iv_dimensiontype = |string|
                      )
                    )
                  )
                )
              )
            )
          )
          it_sourcesegments = VALUE /aws1/cl_cussourcesegment=>tt_sourcesegmentlist(
            ( new /aws1/cl_cussourcesegment( |string| ) )
          )
          iv_sourcetype = |string|
          iv_type = |string|
        )
      )
    )
    iv_include = |string|
  )
  it_tags = VALUE /aws1/cl_custagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_custagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_custagmap_w( |string| )
      )
    )
  )
  iv_description = |string|
  iv_displayname = |string|
  iv_domainname = |string|
  iv_segmentdefinitionname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_name = lo_result->get_segmentdefinitionname( ).
  lv_string1to255 = lo_result->get_displayname( ).
  lv_sensitivetext = lo_result->get_description( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_segmentdefinitionarn = lo_result->get_segmentdefinitionarn( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.