Overview
Use this service to configure the data sent to the SAP Hybris Marketing system from SAP Hybris Profile.
A marketer can use this service to:
- Configure fields in the payload sent to the SAP Hybris Marketing system.
- For example, the default value for the field DIGITAL_ASSET_SYSTEM is
HYBRIS. Marketers who have their own digital asset systems can update this value as required.
- For example, the default value for the field DIGITAL_ASSET_SYSTEM is
- Filter contacts based on interests before sending the data to the SAP Hybris Marketing system.
- A marketer can send data for only those profiles with a higher number of interactions on the website as compared to others. Every web page and asset on the website is linked to an interest. Every profile's interest score for a webpage or asset is stored in SAP Hybris Profile. A marketer can define a threshold score for the interest. If a profile crosses this threshold score, the service sends the data for the profile to the SAP Hybris Marketing system.
- For example, a marketer can use the Profile Services for Marketing Configuration service to set a score for the interest
BIKES. If a person interacting with a webpage or assets linked to the interestBIKES, crosses the threshold score, the system sends that user's data to the SAP Hybris Marketing system.
API Reference
/configuration/{tenant}
This resourceType defines the GET, POST, DELETE methods and their responses for a collection resource.
/configuration/{tenant}
Gets all configuration
/configuration/{tenant}/fields
default values of fields in ymkt
delete the value of fields for hybris Marketing Integration
change default value of fields for Hybris Marketing Integration
create first time fields for Hybris Marketing Integration
/configuration/{tenant}/fields/initialLoad
creates initial configuration
creates initial configuration
/configuration/{tenant}/affinity
sets affinity on an asset or interest. threshold score is required
creates affinity configuration
/configuration/{tenant}/affinity/{type}
updates affinity configuration
delete affinity configuration
Details
Configure fields in the payload sent to Hybris Marketing system
There are few fields in the payload of SAP Hybris Marketing system, whose values can be configured by a Marketer. For example - By default, value of DIGITAL_ASSET_SYSTEM (Digital Asset system) is 'HYBRIS'. Digital Asset System for a Marketer can be either their own repository where all digital assets such as media files are stored, or it can be any other system where digital assets belong to. This value can be configured by Marketer if needed.
However, there are few fields whose values cannot be changed - For example CommunicationMedium inside Interactions. Communication Medium will always be 'WEB', because clickstream is collected from a website.
Filter contacts based on interests before sending data to SAP Hybris Marketing system
Using Secured Graph Service
- A profile is linked to many Affinity nodes. Each affinity node is linked to either an Interest node or an Asset node. So this flow shows that a profile has some affinity towards an interest/asset:
Profile --> Affinity --> Asset
Profile --> Affinity --> Interest
For example: A user named 'George' visited a website and showed interest towards ‘BIKES’. So it looks like this in graph:
George --> Affinity --> BIKES
An Affinity node has a property called ‘counter’ which denotes how many times Interest/Asset was accessed. For example – George accessed items in website which has interest ‘BIKES’ for 20 times. An Affinity node is created which is linked to ‘BIKES’ Interest node. Now, ‘counter’ field in Affinity Node will have value as 20. George --> Affinity(counter: 20) --> BIKES
Lets’ assume, In Profile Services for Marketing Configuration, a threshold value is given for BIKES interest as 10.
After every session end, it will be evaluated if value in ‘counter’ field has crossed the threshold value or not. If threshold value is crossed, then data of the Profile can be sent to Hybris Marketing. In this example, counter value is 20 (greater than 10), so George’s profile data can now be consolidated and sent to Hybris Marketing.
You can define multiple affinities for a tenant. For example - There are two affinities defined:
- 10 for BIKES
- 20 for DRINKS.
In this case, if threshold is crossed for any one of affinities, then George's profile data can be sent to SAP Hybris Marketing system.
Using Profile Service
There are two types of affinities in 'insights' section of profile data:
- interests
- assets
For example, George viewed a video BEST BIKE EVER 4 times. assets section will now have an entry given below:
- assets: { - BEST_BIKE_EVER: { score: 0.3010299956639812, recentScore: 0.3010299956639812, recentViewCount: 4 } }If George accessed video that has interest BIKES, 2 times. interests section will have following entry:
- interests: { - BIKES: { score: 4.3010299956639812, recentViewCount: 2, recentScore: 0.47712125471966244 } }Each affinity has a score associated with it. This score is calculated based on number of times an asset/interest was accessed. From the above example, George has score 0.3010299956639812 for asset BEST_BIKE_EVER.
Let's assume, In Profile Services for Marketing Configuration, a threshold value is given for BIKES interest as 3.34265.
After every session end, it will be evaluated if value in score field has crossed the threshold value or not. If threshold value is crossed, then data of the Profile can be sent to Hybris Marketing. In this example, score value is 4.3010299956639812 (greater than 3.34265), so George’s profile data can now be consolidated and sent to Hybris Marketing.
- Authorization
- Scopes
This table shows the scopes that the Profile Services for Marketing Configuration service supports:
| Scope | Description |
|---|---|
| hybris.profileymktconfig_view | Use this scope to read existing configurations. |
| hybris.profileymktconfig_manage | Use this scope to modify existing configurations. |
Error Types
For more information about error codes, see the detailed error description for each API operation in the API Reference. You can also check the standard error codes in the API best practices.
Scopes
Scopes are strings that you can use to specify the type of access you need to resources and operations in the Profile Services for Marketing Configuration service.
This table shows the scopes that the Profile Services for Marketing Configuration service supports:
| Scope | Description |
|---|---|
| hybris.profileymktconfig_view | Use this scope to read existing configurations. |
| hybris.profileymktconfig_manage | Use this scope to modify existing configurations. |
CRUD Operations on Profile Services for Marketing Configuration
Use this service to configure the data sent to the SAP Hybris Marketing system. This service supports the create, retrieve, update, and delete operations. To perform the basic operations that this service supports, you must have proper authorization, which requires that the header carries the correct access token. The examples in this tutorial lead you through those operations, showing what you need to provide to the methods, and the responses you receive in return. ```javascript clientId = clientIdPlaceholder; clientSecret = clientSecretPlaceholder; tenant = projectIdPlaceholder; client = appIdPlaceholder; scopesRequired = 'hybris.tenant='+tenant+' hybris.profileymktconfig_view hybris.profileymktconfig_manage'; access_token = tokenPlaceholder; ```
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Use our private help channel. Receive updates over email and contact our specialists directly.
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.