/AWS1/IF_EVY=>UPDATEEXPERIMENT()¶
About UpdateExperiment¶
Updates an Evidently experiment.
Don't use this operation to update an experiment's tag. Instead, use TagResource.
Method Signature¶
METHODS /AWS1/IF_EVY~UPDATEEXPERIMENT
IMPORTING
!IV_PROJECT TYPE /AWS1/EVYPROJECTREF OPTIONAL
!IV_EXPERIMENT TYPE /AWS1/EVYEXPERIMENTNAME OPTIONAL
!IV_DESCRIPTION TYPE /AWS1/EVYDESCRIPTION OPTIONAL
!IT_TREATMENTS TYPE /AWS1/CL_EVYTREATMENTCONFIG=>TT_TREATMENTCONFIGLIST OPTIONAL
!IT_METRICGOALS TYPE /AWS1/CL_EVYMETRICGOALCONFIG=>TT_METRICGOALCONFIGLIST OPTIONAL
!IV_RANDOMIZATIONSALT TYPE /AWS1/EVYRANDOMIZATIONSALT OPTIONAL
!IV_SAMPLINGRATE TYPE /AWS1/EVYSPLITWEIGHT OPTIONAL
!IV_SEGMENT TYPE /AWS1/EVYSEGMENTREF OPTIONAL
!IV_REMOVESEGMENT TYPE /AWS1/EVYPRIMITIVEBOOLEAN OPTIONAL
!IO_ONLINEABCONFIG TYPE REF TO /AWS1/CL_EVYONLINEABCONFIG OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_evyupdexperimentrsp
RAISING
/AWS1/CX_EVYACCESSDENIEDEX
/AWS1/CX_EVYCONFLICTEXCEPTION
/AWS1/CX_EVYRESOURCENOTFOUNDEX
/AWS1/CX_EVYVALIDATIONEX
/AWS1/CX_EVYCLIENTEXC
/AWS1/CX_EVYSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_project TYPE /AWS1/EVYPROJECTREF /AWS1/EVYPROJECTREF¶
The name or ARN of the project that contains the experiment that you want to update.
iv_experiment TYPE /AWS1/EVYEXPERIMENTNAME /AWS1/EVYEXPERIMENTNAME¶
The name of the experiment to update.
Optional arguments:¶
iv_description TYPE /AWS1/EVYDESCRIPTION /AWS1/EVYDESCRIPTION¶
An optional description of the experiment.
it_treatments TYPE /AWS1/CL_EVYTREATMENTCONFIG=>TT_TREATMENTCONFIGLIST TT_TREATMENTCONFIGLIST¶
An array of structures that define the variations being tested in the experiment.
it_metricgoals TYPE /AWS1/CL_EVYMETRICGOALCONFIG=>TT_METRICGOALCONFIGLIST TT_METRICGOALCONFIGLIST¶
An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
iv_randomizationsalt TYPE /AWS1/EVYRANDOMIZATIONSALT /AWS1/EVYRANDOMIZATIONSALT¶
When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and
randomizationSalt. If you omitrandomizationSalt, Evidently uses the experiment name as therandomizationSalt.
iv_samplingrate TYPE /AWS1/EVYSPLITWEIGHT /AWS1/EVYSPLITWEIGHT¶
The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.
iv_segment TYPE /AWS1/EVYSEGMENTREF /AWS1/EVYSEGMENTREF¶
Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.
iv_removesegment TYPE /AWS1/EVYPRIMITIVEBOOLEAN /AWS1/EVYPRIMITIVEBOOLEAN¶
Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
io_onlineabconfig TYPE REF TO /AWS1/CL_EVYONLINEABCONFIG /AWS1/CL_EVYONLINEABCONFIG¶
A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_evyupdexperimentrsp /AWS1/CL_EVYUPDEXPERIMENTRSP¶
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->updateexperiment(
io_onlineabconfig = new /aws1/cl_evyonlineabconfig(
it_treatmentweights = VALUE /aws1/cl_evytreatmenttowtmap_w=>tt_treatmenttoweightmap(
(
VALUE /aws1/cl_evytreatmenttowtmap_w=>ts_treatmenttoweightmap_maprow(
value = new /aws1/cl_evytreatmenttowtmap_w( 123 )
key = |string|
)
)
)
iv_controltreatmentname = |string|
)
it_metricgoals = VALUE /aws1/cl_evymetricgoalconfig=>tt_metricgoalconfiglist(
(
new /aws1/cl_evymetricgoalconfig(
io_metricdefinition = new /aws1/cl_evymetricdefnconfig(
iv_entityidkey = |string|
iv_eventpattern = |string|
iv_name = |string|
iv_unitlabel = |string|
iv_valuekey = |string|
)
iv_desiredchange = |string|
)
)
)
it_treatments = VALUE /aws1/cl_evytreatmentconfig=>tt_treatmentconfiglist(
(
new /aws1/cl_evytreatmentconfig(
iv_description = |string|
iv_feature = |string|
iv_name = |string|
iv_variation = |string|
)
)
)
iv_description = |string|
iv_experiment = |string|
iv_project = |string|
iv_randomizationsalt = |string|
iv_removesegment = ABAP_TRUE
iv_samplingrate = 123
iv_segment = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lo_experiment = lo_result->get_experiment( ).
IF lo_experiment IS NOT INITIAL.
lv_experimentarn = lo_experiment->get_arn( ).
lv_experimentname = lo_experiment->get_name( ).
lv_projectarn = lo_experiment->get_project( ).
lv_experimentstatus = lo_experiment->get_status( ).
lv_description = lo_experiment->get_statusreason( ).
lv_description = lo_experiment->get_description( ).
lv_timestamp = lo_experiment->get_createdtime( ).
lv_timestamp = lo_experiment->get_lastupdatedtime( ).
lo_experimentschedule = lo_experiment->get_schedule( ).
IF lo_experimentschedule IS NOT INITIAL.
lv_timestamp = lo_experimentschedule->get_analysiscompletetime( ).
ENDIF.
lo_experimentexecution = lo_experiment->get_execution( ).
IF lo_experimentexecution IS NOT INITIAL.
lv_timestamp = lo_experimentexecution->get_startedtime( ).
lv_timestamp = lo_experimentexecution->get_endedtime( ).
ENDIF.
LOOP AT lo_experiment->get_treatments( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_treatmentname = lo_row_1->get_name( ).
lv_description = lo_row_1->get_description( ).
LOOP AT lo_row_1->get_featurevariations( ) into ls_row_2.
lv_key = ls_row_2-key.
lo_value = ls_row_2-value.
IF lo_value IS NOT INITIAL.
lv_variationname = lo_value->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
ENDLOOP.
LOOP AT lo_experiment->get_metricgoals( ) into lo_row_3.
lo_row_4 = lo_row_3.
IF lo_row_4 IS NOT INITIAL.
lo_metricdefinition = lo_row_4->get_metricdefinition( ).
IF lo_metricdefinition IS NOT INITIAL.
lv_cwdimensionsafename = lo_metricdefinition->get_name( ).
lv_jsonpath = lo_metricdefinition->get_entityidkey( ).
lv_jsonpath = lo_metricdefinition->get_valuekey( ).
lv_jsonvalue = lo_metricdefinition->get_eventpattern( ).
lv_metricunitlabel = lo_metricdefinition->get_unitlabel( ).
ENDIF.
lv_changedirectionenum = lo_row_4->get_desiredchange( ).
ENDIF.
ENDLOOP.
lv_randomizationsalt = lo_experiment->get_randomizationsalt( ).
lv_splitweight = lo_experiment->get_samplingrate( ).
lv_segmentarn = lo_experiment->get_segment( ).
lv_experimenttype = lo_experiment->get_type( ).
lo_onlineabdefinition = lo_experiment->get_onlineabdefinition( ).
IF lo_onlineabdefinition IS NOT INITIAL.
lv_treatmentname = lo_onlineabdefinition->get_controltreatmentname( ).
LOOP AT lo_onlineabdefinition->get_treatmentweights( ) into ls_row_5.
lv_key_1 = ls_row_5-key.
lo_value_1 = ls_row_5-value.
IF lo_value_1 IS NOT INITIAL.
lv_splitweight = lo_value_1->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
LOOP AT lo_experiment->get_tags( ) into ls_row_6.
lv_key_2 = ls_row_6-key.
lo_value_2 = ls_row_6-value.
IF lo_value_2 IS NOT INITIAL.
lv_tagvalue = lo_value_2->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
ENDIF.