After July 2021, the 2.3.x release line no longer received quality updates or user guide updates. PHP 7.3 reached end of support in December 2021, and Adobe Commerce 2.3.x reached end of support in September 2022. We strongly recommend upgrading to Adobe Commerce 2.4.x to help maintain PCI compliance.

Adding Product Video

This site contains archived merchant documentation for a version of Adobe Commerce and Magento Open Source that has reached end-of-support. The documentation available here is intended for historical reference only and is not maintained. The Adobe Commerce Merchant Documentation for current releases is published on the Adobe Experience League.

To add product video, you must first obtain an API Key from your Google account and enter it in the configuration of your store. Then, you can link to the video from the product.

Step 1: Get your YouTube API key

  1. Log in to your Google account and visit the Google Developers Console.

  2. For Search at the top, enter YouTube Data API v3 and click the search icon.

  3. When the API page is displayed, make sure it is enabled.

  4. In the left panel, choose Credentials.

  5. Depending on whether you have credentials or not, do one of the following:

    • If you already have the needed credentials, copy the key in the API keys table.

    • If you do not already have credentials for this API, click Create Credentials at the top and follow the prompts to create the needed credentials. Under Get your credentials, copy the API key and click Done.

  6. Copy the API key to the clipboard.

  7. Click the Edit icon on the right and set the restrictions to make sure the API key is limited to the correct referrers.

  8. Wait a few moments while the key is generated and then copy the key to the clipboard.

    In the next step, you will paste the key into your store’s configuration.

Step 2: Configure the key in Magento

  1. On the Admin sidebar, go to Stores > Settings > Configuration.

  2. In the left panel, expand Catalog and choose Catalog underneath.

  3. Expand the Product Video section and paste your YouTube API key.

    Product Video

  4. When complete, click Save Config.

  5. When prompted, refresh the cache.

  1. Open a product in edit mode.

  2. In the Images and Video section, click Add Video.

    If you haven’t yet configured your YouTube API key, click OK to continue. You won’t be able to link to a YouTube video, but you can go through the process.

    Add Video

  3. Enter the URL of the YouTube or Vimeo video.

  4. Click outside the field and wait for feedback on the API key or video.

    If everything checks out, Youtube provides base information of the video

  5. Enter the Title and Description of the video.

  6. To upload a Preview Image, browse to the image and select the file.

  7. If you prefer to use the video meta data, click Get Video Information.

  8. To determine how the video is used in the store, select the checkbox of each Role that applies:

    • Base Image
    • Small Image
    • Swatch Image
    • Thumbnail
    • Hide from Product Page

  9. When complete, click Save.

    New Video

Field reference

Field Description
URL The URL of the associated video.
Title The video title.
Description The video description.
Preview Image An uploaded image that is used as a preview of the video in your store.
Get Video Information Retrieves the video meta data that is stored on the host server. You can use the original data or update it as needed.
Role Determines how the preview image is used in your store. You can choose any combination of options: Base Image, Small Image, Thumbnail, Swatch Image, Hide from Product Page
© 2024 Adobe. All rights reserved.