Frequently Asked Questions - thlucas1/homeassistantcomponent_spotifyplus GitHub Wiki

Welcome to the SpotifyPlus custom component integration for Home Assistant frequently asked questions (FAQ) wiki.

Use the following index to quickly find what you are looking for.

How do I access dictionary items from a Service Response

All of the SpotifyPlus services that retrieve data from the Spotify Web API will return the data in a dictionary format in the service response. The data can then be processed in a template and used however you wish.

For example, consider the following service call to retrieve all albums for an artist:

action: spotifyplus.get_artist_albums
data:
  entity_id: media_player.spotifyplus_todd_l
  artist_id: 6APm8EjxOHSYM5B4i3vT3q
  include_groups: album
  limit_total: 10
  sort_result: true

The results would look like this (shortened for brevity, actual result will contain MUCH more data):

result:
  date_last_refreshed: 1739564010.147239
  items:
    - album_type: album
      artists:
        - id: 6APm8EjxOHSYM5B4i3vT3q
          name: MercyMe
          uri: spotify:artist:6APm8EjxOHSYM5B4i3vT3q
      id: 2ezUrMWSvn9nYsI6DvdCgW
      image_url: https://i.scdn.co/image/ab67616d0000b2732e7368a96604933f6a87b97a
      name: "10"
      total_tracks: 25
      uri: spotify:album:2ezUrMWSvn9nYsI6DvdCgW
    - album_type: album
      artists:
        - id: 6APm8EjxOHSYM5B4i3vT3q
          name: MercyMe
          uri: spotify:artist:6APm8EjxOHSYM5B4i3vT3q      
      id: 4nZS59zzTABfnSPq7a9iP1
      image_url: https://i.scdn.co/image/ab67616d0000b2733e8dc4e2eb7551afa8db3339
      name: All That Is Within Me
      total_tracks: 10
      uri: spotify:album:4nZS59zzTABfnSPq7a9iP1

The Problem
When you go to process the data in your template processing, your first thought is to access the repeating items collection data using something like this:

artist_name: "{{serviceResponse.result.items[0].name}}"

which will result in an error that looks like this:

Error rendering data template: UndefinedError: builtin_function_or_method object has no element 0.

Keep in mind that you are processing data that is returned in a dictionary using Python; the Python dictionary class has a METHOD named items, which is not to be confused with the items KEY that is returned in the dictionary. The result.items[0].name statement is trying to call the Python items METHOD, which results in the builtin_function_or_method object has no element 0 error.

The Solution
You have to reference items as a dictionary KEY so that it's not inferred as a METHOD, like so:

artist_name: "{{serviceResponse.result['items'][0].name}}"

Here's a simple example I tested in the HA Developer Tools \ Templates editor:

{%-
set serviceResponse = {
  "result": {
    "items": [
      {
        "artists": [
          {
            "name": "MercyMe",
            "uri": "spotify:artist:6APm8EjxOHSYM5B4i3vT3q"
          }
        ],
        "image_url": "https://i.scdn.co/image/ab67616d0000b2732e7368a96604933f6a87b97a",
        "name": "10",
        "uri": "spotify:album:2ezUrMWSvn9nYsI6DvdCgW"
      },
      {
        "artists": [
          {
            "name": "MercyMe",
            "uri": "spotify:artist:6APm8EjxOHSYM5B4i3vT3q"
          }
        ],
        "image_url": "https://i.scdn.co/image/ab67616d0000b2733e8dc4e2eb7551afa8db3339",
        "name": "All That Is Within Me",
        "uri": "spotify:album:4nZS59zzTABfnSPq7a9iP1"
      }
    ]
  }
}
-%}

Artist Albums: {{"\n"}}
{%- for item in serviceResponse['result']['items'] -%}
  {%- set trackName = item['name'] | default('') -%}
  {%- set trackImageUrl = item['image_url'] | default('') -%}
  {%- set trackUri = item['uri'] | default('') -%}
  {%- set trackArtist = item['artists'][0]['name'] | default('') -%}
  - {{ trackName }} ({{trackUri}}) - {{ trackArtist }} {{"\n"}}
{%- endfor -%}

{{"\n"}}
1st item result A = {{ serviceResponse['result']['items'][0]['uri'] }}
1st item result B = {{ serviceResponse.result['items'][0].uri }}
1st item result C = {{ serviceResponse.result.items[0].uri }}    <- this fails

OAuth Redirect Errors - INVALID_CLIENT: Invalid client

This error can occur sometimes when initially installing the SpotifyPlus (or even Spotify) integration. I believe it's due to a malformed Redirect URI value in the Spotify Developer Application details.

To fix this, you need to do ALL of the following:

  1. verify that the https://my.home-assistant.io/redirect/oauth uri is listed in the Spotify Developer Application settings "Redirect URIs" list. This is an internal url that Home Assistant uses to intercept the OAuth2 request redirect result. The entry must be listed exactly as it is spelled (case-sensitive), and without the ending slash.

  2. Go to the Home Assistant Application Credentials settings (under Settings \ Devices, click on 3 vertical dots menu in upper right and select Application Credentials) and see if it created any OAuth application credentials related to SpotifyPlus (or Spotify if you're installing Spotify). If so, delete them.

  3. Open the Spotify Web Player in a new browser window and logout of Spotify. This will force you into a logon screen the next time you try to authorize the OAuth request.

How can I play music on my Chromecast Devices?

Follow the SpotifyPlus Device Configuration - Google Chromecast Device Support instructions to setup your Spotify Web Player Authentication Credentials token.

Then just select the Chromecast device as your source in your favorite media player and it should play.

Why does the media player support turn_on / turn_off?

There are a few reasons why the integration supports the turn_on / turn_off features by default.

  • The Spotify Web API will not be queried when the media player is turned off - this is by design. It reduces traffic on your local network, as well as the extra load placed on Spotify Web API servers (and your Home Assistant instance) that service the request.

  • Executes the Turn On Script option (if specified) when the player is turned on. This option allows you to specify a script that will be executed when a turn_on service request is made to power on the integration. The script can be used to prepare the audio output device(s) (e.g. speaker, AV receiver, etc) for playing Spotify Connect Player content.

  • Executes the Turn Off Script option (if specified) when the player is turned off. This option allows you to specify a script that will be executed when a turn_off service request is made to power off the integration. The script can be used to shut down the audio output device(s) (e.g. speaker, AV receiver, etc) after playing Spotify Connect Player content.

If you prefer "always on" functionality, you can disable the turn on / off features using the Always On configuration option.

SAM1010E Deprecated Error Messages

The following error message is displayed when trying to retrieve information from various Spotify Web API endpoints:

SAM1010E - The "x" endpoint has been deprecated by Spotify without prior notice as of November 27th 2024, and the supporting functionality is no longer available.

Why is it like this?

The Spotify Developer Team deprecated (aka removed) the following functionality without any sort of warning or grace period. This was announced on the Spotify Developer Forum Blog on Thursday November 27th 2024 (US Thanksgiving holiday - definitely not worth giving thanks for IMHO!) AFTER the changes were already implemented. The Spotify Web API will no longer be able to access or use the following endpoints and functionality in third-party applications (SpotifyPlus being one of them):

  1. Related Artists
  2. Recommendations
  3. Audio Features
  4. Audio Analysis
  5. Get Featured Playlists
  6. Get Category's Playlists
  7. 30-second preview URLs, in multi-get responses (SimpleTrack object)
  8. Algorithmic and Spotify-owned editorial playlists (e.g. "Made For You", etc)

What these changes mean for SpotifyPlus Integration and SpotifyPlus Card Dashboard users is that the corresponding functions that access the above features will no longer work, and in most case will return the SAM1010E error message.

Unfortunately, this is out of my control as the Spotify developers just decided to make the change to their API without prior notice, and my (and many other) complaints fall on deaf ears. Let's just say I lost a LOT of respect for the Spotify platform after over the past few days after realizing what they did and their lack of communication!

How do I fix it?

Use the Spotify Web Player Cookie Credentials SP_DC, SP_KEY integration configuration options UI to configure support for Spotify Connect player control. This will cause the integration to utilize the Spotify Web Player elevated access token for the functionality in question.

Also, you can make your voice and opinion heard by posting a reply on the Spotify Community Forum. Let them know that this change is not acceptable and how disappointed you are. Please be respectful in the process; scream and shout with your internal voice if you have to (like I did).

How do I find the device_id value required by various service calls?

Most of the integration custom services require a device_id argument in order to process a command. The device_id argument is usually passed to the corresponding Spotify Web API endpoint for the specified service. The device_id is also referred to as the Spotify Connect device id, and in some instances the Spotify Connect device name. Most services will allow you to specify either the name (e.g. Office Speaker) or the id (e.g. f87342b3ad455375317d5af8aabde64a28bd49d0).

The Spotify Connect device name can be found in the Spotify Mobile / Desktop App “Connect to a device” menu:

You can also find the device name and device id via the Get Spotify Connect Devices service output. Use the HA Developer Tools \ Services to call the service and display the results.

Example: Get Spotify Connect Devices

service: spotifyplus.get_spotify_connect_devices
data:
  entity_id: media_player.spotifyplus_todd_l

Sample Output
The result id value is the device id, the result name is the device name.

user_profile:
  display_name: Todd L
  ...
result:
  - id: 30fbc80e35598f3c242f2120413c943dfd9715fe
    is_active: false
    is_private_session: false
    is_restricted: false
    name: Bose-ST10-1
    supports_volume: false
    type: SPEAKER
    volume_percent: 0
  - id: 3756903295ba7b47f8c36fc9a4ff7d833431a667
    is_active: false
    is_private_session: false
    is_restricted: false
    name: Bose-ST300
    supports_volume: false
    type: SPEAKER
    volume_percent: 0
  - id: 10e64fcf9695bd2796ce62b84d688558e39cd311
    is_active: false
    is_private_session: false
    is_restricted: false
    name: HAVM-SpotifyConnect
    supports_volume: false
    type: Speaker
    volume_percent: 0
  - id: f87342b3ad455375317d5af8aabde64a28bd49d0
    is_active: false
    is_private_session: false
    is_restricted: false
    name: Office
    supports_volume: false
    type: SPEAKER
    volume_percent: 0

How do I find the Spotify "Daily Mix n" playlist id?

The Spotify generated Daily Mix n entries are just playlists, with an assigned playlist id. I believe the playlist id's remain the same, even though the content automatically changes (not sure of change frequency).

To find out the playlist id (and it's uri value), do the following:

  1. open Spotify Web Site in a new desktop browser window.
  2. click on the desired "Daily Mix ?" entry to display it's details; this will display the playlist id in the url (playlist id is circled in red in the following example):
  1. formulate the Spotify uri value for the playlist; in the example above, the uri would be spotify:playlist:37i9dQZF1E39DIjrju3A9t.

Use the Spotify playlist uri value in the call to SpotifyPlus player_media_play_context service:

service: spotifyplus.player_media_play_context
data:
  entity_id: media_player.spotifyplus_john_s
  context_uri: spotify:playlist:37i9dQZF1E39DIjrju3A9t