Skip to content
Nappai Documentation

Playlist Item

This component allows you to interact with your YouTube Playlists. You can use it to view videos in a playlist, add new videos to a specific playlist, or organize the order of videos within that playlist. It acts as a bridge between your Nappai automation and the YouTube platform, requiring you to connect your Google account to function.

How it Works

This component connects to the YouTube API using the credentials you provide. Once connected, it can perform actions on a specific playlist identified by its ID. It retrieves information about videos (playlists items), adds new videos to the list, or updates their position within the playlist. The results are returned in a structured format that you can use in subsequent steps of your automation.

Connection & Credentials

This component requires configuring a credential in the Nappai panel before interacting with the external service:

  1. Go to the Credentials section in your Nappai panel.
  2. Create a new credential of the type Youtube API and fill in the required fields (Google Cloud Project Client Id, Client Secret, etc.). You can find your API key in the Google Cloud Console.
  3. In your workflow, select the saved credential in the Credential input field of this node.

Inputs

The following fields are available to configure this component. Each field may be visible in different operations:

  • Operation: Select the type of action you want to perform (e.g., listing items or adding a video).
  • Item ID: Introduce the ID of the playlist item to interact with. This is typically used when you need to modify or delete a specific existing item in the playlist.
  • Playlist ID: Introduce the ID or the url of the playlist to interact with. This is the main container for the videos you want to manage.
  • Max Results: The maximum number of results to return. Use this when listing items to control how many videos are retrieved at once.
  • Video ID: Introduce the ID of the video to add to the playlist. Use this when you want to include a new video in your playlist.
  • Index: The index of the video in the playlist. Use this to specify where a video should appear in the list (e.g., first position, second position).

Outputs

  • Result: Contains the data returned by the YouTube API. This is usually a JSON object containing details about the playlist items, such as video titles, IDs, and positions, or a confirmation message if an item was successfully added or updated.

Output Data Example (JSON)json

{ “kind”: “youtube#playlistItemListResponse”, “etag”: “sample_etag_string”, “items”: [ { “kind”: “youtube#playlistItem”, “etag”: “item_etag”, “id”: “UUIWxXxXxXxXxXxXxX”, “snippet”: { “publishedAt”: “2023-10-27T10:00:00.000Z”, “playlistId”: “PLxxxxx”, “resourceId”: { “kind”: “youtube#video”, “videoId”: “dQw4w9WgXcQ” }, “title”: “My Awesome Video”, “thumbnails”: { “default”: { “url”: “https://i.ytimg.com/vi/dQw4w9WgXcQ/default.jpg”, “width”: 120, “height”: 90 } }, “channelId”: “UCxxxxx”, “description”: “Description of the video”, “position”: 0 }, “status”: { “privacyStatus”: “public” } } ], “pageInfo”: { “totalResults”: 1, “resultsPerPage”: 1 } }

Connectivity

This component is typically used after you have retrieved a Playlist ID from another component (such as a “Get Playlists” component). It is also commonly followed by components that need to process the video data, such as an “Analyze Video Title” or “Save to Database” component. If you are adding a video, you will likely need the Video ID from a previous search or upload step.

Usage Example

Scenario: Listing Videos in a Playlist

  1. You have a Playlist ID (e.g., PLrAXtmErZgOeiCM4KVvlF3dYg0tD4Z2lQ).
  2. Drag the Playlist Item component into your workflow.
  3. In the Credential field, select your YouTube API credential.
  4. Paste your Playlist ID into the Playlist ID field.
  5. Set Max Results to 10 if you only want the first 10 videos.
  6. Connect this component to a “Data Processor” or “Email Sender” to work with the list of videos returned in the Result output.

Tips and Best Practices

  • Playlist ID Format: Ensure you use the specific Playlist ID (usually starting with PL...) rather than the public URL. If you only have a URL, you may need a parser component to extract the ID.
  • Video ID: When adding videos, make sure the Video ID is correct. A wrong ID will result in an error or an empty playlist addition.
  • Indexing: When setting the Index, remember that positions usually start at 0 (the first position).
  • Authentication: Always ensure your Google Cloud Credentials have the necessary permissions to read and modify your playlists.

Security Considerations

  • Ensure your Google Cloud Credentials are kept secure and are not exposed in public workflows.
  • Be cautious when handling Playlist IDs that may contain sensitive content if the playlist is not private.