Skip to content

/AWS1/IF_CUS=>GETPROFILERECOMMENDATIONS()

About GetProfileRecommendations

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

Method Signature

METHODS /AWS1/IF_CUS~GETPROFILERECOMMENDATIONS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IV_PROFILEID TYPE /AWS1/CUSUUID OPTIONAL
    !IV_RECOMMENDERNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IT_CONTEXT TYPE /AWS1/CL_CUSRECOMMENDERCTX_W=>TT_RECOMMENDERCONTEXT OPTIONAL
    !IT_RECOMMENDERFILTERS TYPE /AWS1/CL_CUSRECOMMENDERFILTER=>TT_RECOMMENDERFILTERS OPTIONAL
    !IT_RECOMMENDERPROMOFILTERS TYPE /AWS1/CL_CUSRECMDRPROMOFILTER=>TT_RECOMMENDERPROMOFILTERS OPTIONAL
    !IT_CANDIDATEIDS TYPE /AWS1/CL_CUSCANDIDATEIDLIST_W=>TT_CANDIDATEIDLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CUSMAXSIZE500 OPTIONAL
    !IO_METADATACONFIG TYPE REF TO /AWS1/CL_CUSMETADATACONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cusgetprofilerecsrsp
  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_profileid TYPE /AWS1/CUSUUID /AWS1/CUSUUID

The unique identifier of the profile for which to retrieve recommendations.

iv_recommendername TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the recommender.

Optional arguments:

it_context TYPE /AWS1/CL_CUSRECOMMENDERCTX_W=>TT_RECOMMENDERCONTEXT TT_RECOMMENDERCONTEXT

The contextual metadata used to provide dynamic runtime information to tailor recommendations.

it_recommenderfilters TYPE /AWS1/CL_CUSRECOMMENDERFILTER=>TT_RECOMMENDERFILTERS TT_RECOMMENDERFILTERS

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

it_recommenderpromofilters TYPE /AWS1/CL_CUSRECMDRPROMOFILTER=>TT_RECOMMENDERPROMOFILTERS TT_RECOMMENDERPROMOFILTERS

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

it_candidateids TYPE /AWS1/CL_CUSCANDIDATEIDLIST_W=>TT_CANDIDATEIDLIST TT_CANDIDATEIDLIST

A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

iv_maxresults TYPE /AWS1/CUSMAXSIZE500 /AWS1/CUSMAXSIZE500

The maximum number of recommendations to return. The default value is 10.

io_metadataconfig TYPE REF TO /AWS1/CL_CUSMETADATACONFIG /AWS1/CL_CUSMETADATACONFIG

Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

RETURNING

oo_output TYPE REF TO /aws1/cl_cusgetprofilerecsrsp /AWS1/CL_CUSGETPROFILERECSRSP

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->getprofilerecommendations(
  io_metadataconfig = new /aws1/cl_cusmetadataconfig(
    it_metadatacolumns = VALUE /aws1/cl_cusmetcolumnslist_w=>tt_metadatacolumnslist(
      ( new /aws1/cl_cusmetcolumnslist_w( |string| ) )
    )
  )
  it_candidateids = VALUE /aws1/cl_cuscandidateidlist_w=>tt_candidateidlist(
    ( new /aws1/cl_cuscandidateidlist_w( |string| ) )
  )
  it_context = VALUE /aws1/cl_cusrecommenderctx_w=>tt_recommendercontext(
    (
      VALUE /aws1/cl_cusrecommenderctx_w=>ts_recommendercontext_maprow(
        key = |string|
        value = new /aws1/cl_cusrecommenderctx_w( |string| )
      )
    )
  )
  it_recommenderfilters = VALUE /aws1/cl_cusrecommenderfilter=>tt_recommenderfilters(
    (
      new /aws1/cl_cusrecommenderfilter(
        it_values = VALUE /aws1/cl_cusrecmdrfiltervals_w=>tt_recommenderfiltervalues(
          (
            VALUE /aws1/cl_cusrecmdrfiltervals_w=>ts_recmdrfiltervalues_maprow(
              value = new /aws1/cl_cusrecmdrfiltervals_w( |string| )
              key = |string|
            )
          )
        )
        iv_name = |string|
      )
    )
  )
  it_recommenderpromofilters = VALUE /aws1/cl_cusrecmdrpromofilter=>tt_recommenderpromofilters(
    (
      new /aws1/cl_cusrecmdrpromofilter(
        it_values = VALUE /aws1/cl_cusrecmdrfiltervals_w=>tt_recommenderfiltervalues(
          (
            VALUE /aws1/cl_cusrecmdrfiltervals_w=>ts_recmdrfiltervalues_maprow(
              value = new /aws1/cl_cusrecmdrfiltervals_w( |string| )
              key = |string|
            )
          )
        )
        iv_name = |string|
        iv_percentpromoteditems = 123
        iv_promotionname = |string|
      )
    )
  )
  iv_domainname = |string|
  iv_maxresults = 123
  iv_profileid = |string|
  iv_recommendername = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_recommendations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_catalogitem = lo_row_1->get_catalogitem( ).
      IF lo_catalogitem IS NOT INITIAL.
        lv_sensitivestring1to255 = lo_catalogitem->get_id( ).
        lv_sensitivestring1to255 = lo_catalogitem->get_name( ).
        lv_sensitivestring1to255 = lo_catalogitem->get_code( ).
        lv_sensitivestring1to255 = lo_catalogitem->get_type( ).
        lv_sensitivestring1to255 = lo_catalogitem->get_category( ).
        lv_sensitivestring1to255 = lo_catalogitem->get_description( ).
        lv_sensitivestring1to1000 = lo_catalogitem->get_additionalinformation( ).
        lv_sensitivestring1to1000 = lo_catalogitem->get_imagelink( ).
        lv_sensitivestring1to1000 = lo_catalogitem->get_link( ).
        lv_timestamp = lo_catalogitem->get_createdat( ).
        lv_timestamp = lo_catalogitem->get_updatedat( ).
        lv_sensitivestring1to255 = lo_catalogitem->get_price( ).
        LOOP AT lo_catalogitem->get_attributes( ) into ls_row_2.
          lv_key = ls_row_2-key.
          lo_value = ls_row_2-value.
          IF lo_value IS NOT INITIAL.
            lv_string1to255 = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_double0to1 = lo_row_1->get_score( ).
    ENDIF.
  ENDLOOP.
ENDIF.