Configure ratings

You can configure your ratings to use either one or two buttons. Once you’ve determined whether to use a one-button or two-button implementation, you can set up your Content Actions.

One-button rating implementation

In a one-button rating system, users express their preference for a song by interacting with a single heart button. This button toggles between two states: neutral and positive. When listeners engage with this button, they influence whether the song will be recommended in the future.

To implement one-button rating:

  1. Navigate to the Content Actions page of your Integration Submission Form.

  2. Select the + Add Content Action button. A Content Action section will appear.

  3. Under Content Action, provide a(n):

    1. Action name, such as ratings-one-button,

    2. Placement location; this field value must be NOW_PLAYING,

    3. selection of Resource content types, such as Track.

  4. Under the State section, provide a State name. This name must be an integer, such as 100.

  5. Under Action Input, provide a(n):

    1. action input Name, such as inactive-heart,
    2. localization resource Title name, such as now-playing-heart-unselected,
    3. Icon image, such as HEART_UNSELECTED,
    4. On Action Set Value, such as 0,
    5. selection on whether to Skip,
    6. Labels for Success Text and Failure Text. This will map to the text you define in the Localization Resources page.
  6. Select the + Add State Action button to create another state section.

  7. Repeat Steps 4-5 to create the second state for the Action.

  8. Select the Save button to save your changes.

The following is an example of a one-button implementation using the examples listed above:

First Action StateSecond Action State

Two-button rating implementation

In a two-button rating system, each of the two buttons has two states: neutral and either positive or negative. When users interact with these buttons, such as clicking a thumbs-up or thumbs-down icon to express their preference for a song, it influences whether the song will be recommended again or skipped in future selections, respectively.

To implement two-button rating:

  1. Navigate to the Content Actions page of your Integration Submission Form.

  2. Select the + Add Content Action button. A Content Action section will appear.

  3. Under Content Action, provide a(n):

    1. Action name, such as ratings-two-buttons

    2. Placement location. This field value must be NOW_PLAYING.

    3. selection of Resource content types, such as Track and Album.

  4. Under the State section, provide a State name. This name must be an integer, such as 100.

  5. Under Action Input, provide a(n):

    1. action input Name, such as inactive-thumbsup,
    2. localization resource Title name, such as now-playing-thumbsup-unselected,
    3. Icon image, such as THUMBSUP_UNSELECTED,
    4. On Action Set Value, such as 0,
    5. selection on whether to Skip,
    6. Labels for Success Text and Failure Text. This will map to the text you define in the Localization Resources page.
  6. Add another action input by selecting the +Add Action Input button.

  7. Repeat Step 5 for the second button’s action input.

  8. To add another State, select the +Add Action State button.

  9. Repeat Steps 4-5 to create multiple states for the Action.

  10. Select the Save button to save your changes.

First Action State

First Action InputSecond Action Input

Second Action State

First Action InputSecond Action Input

Third Action State

First Action InputSecond Action Input

Content Action fields

Content Action fields

📘

All field entries are case-sensitive.

FieldTypeDescription
ActionstringName of the property to set when invoking the indicated action.
PlacementstringUneditable. Defaults to NOW_PLAYING.
ResourcesarrayContent type the action can be used on.

State fields

FieldTypeDescription
StatestringState allowed for an action.
NamestringDescriptive name for object input.
TitlestringName referenced in your Localization Resources page. Corresponding string value will be used in Accessibility features.
IconActionIconIcon used for the respective Action Input.
On Action Set ValueintegerValue to be set when Action Input is enabled.
SkipbooleanFlag indicating to skip playback when action is invoked.
Failure TextstringName referenced in your Localization Resources page. Will display mapped string value if action is unsuccessful.
Success TextstringName referenced in your Localization Resources page. Will display mapped string value when action is successful.