Using Media Assets on Products

Adding an asset

Let's add a simple asset, a PDF, to the product variant:

POST /{projectKey}/products/<product-id> with:

{
  "version": 1,
  "actions": [{
    "action": "addAsset",
    "variantId": 1,
    "asset": {
      "sources": [
        {
          "uri": "http://example.org/content/product-manual.pdf",
          "contentType": "application/pdf"
        }
      ],
      "name": { "en" : "Product Manual" },
      "description": { "en" : "The manual for my product." },
      "tags": ["manual", "pdf"]
    }
  }]
}

We've set a name and a description. We've also added tags and set the optional contentType on the source. Both can be used by your frontend to decide how to display the asset, or search for a specific one in the assets array. For example, if there is a Manual-Section on your product details page, you can search for all assets that have the tag manual, and based on the contentType decide whether to show the content in a PDF viewer or a video player.

Using tags

Here are a two examples for the use of tags. You can use them whenever you want to help your frontend to display the assets.

Using tags for languages

You may add a tag for the language of the asset. For example, a video may be localized into different languages. With the help of a tag, the frontend can pick the right asset to display.

{
  "assets": [
    {
      "tags": ["video", "en"],
      [...]
    }, {
      "tags": ["video", "de"],
      [...]
    }, {
      "tags": ["video", "fr"],
      [...]
    }
  ]
}

Using tags for images in different aspect ratios

Depending on the device or view, you may want to present the content in a different aspect ratio. For example on a desktop, the landscape version of an image is shown, but on a mobile device the portrait version is preferred.

{
  "assets": [
    {
      "tags": ["image", "primary", "landscape"],
      [...]
    }, {
      "tags": ["image", "primary", "portrait"],
      [...]
    },
    [...]
  ]
}

In this example, the primary image exists in two versions - landscape and portrait.

Using tags for 360 degree images

For 360 degree images, you will have multiple assets (for example you may shoot an image at every 10 degrees). With the tags, your frontend can figure out which of the assets make up the 360 degree image, and in which order.

{
  "assets": [
    {
      "tags": ["image"],
      [...]
    }, {
      "tags": ["360-image", "deg=0"],
      [...]
    }, {
      "tags": ["360-image", "deg=10"],
      [...]
    }, {
      "tags": ["360-image", "deg=20"],
      [...]
    },
    [...]
  ]
}

In this example, the first image is a regular one. The following ones belong to the 360 degree image, and indicate with a tag at which angle they've been shot.

Using Asset Sources

An AssetSource is a representation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution. To pick the right source, you can optionally supply a key or the dimensions of the asset.

Using Asset Sources for offering an image in different resolutions

In this example, the image is available in three resolutions: One is a thumb to be displayed on a product overview page, one is a regular resolution to be displayed on a product details page, and one is a high-res version to be used when the customer zooms into the image.

{
  "assetId": "<id>",
  "name": { "en" : "My Product Image" },
  "sources": [
    {
      "uri": "http://example.org/product-full.jpg",
      "dimensions": {"w": 600, "h": 400},
      "key": "full"
    },
    {
      "uri": "http://example.org/product-thumb.jpg",
      "dimensions": {"w": 90, "h": 60},
      "key": "thumb"
    },
    {
      "uri": "http://example.org/product-zoom.jpg",
      "dimensions": {"w": 3000, "h": 2000},
      "key": "zoom"
    }
  ]
}

In this example, both the key and the dimensions are set. The frontend may use the key to find the thumbnail by finding the source for which the key is "thumb". Alternatively, one could save many resolutions, and the frontend could figure out which image is best used (for example a thumbnail on a retina-display would use a different resolution than on a regular display).

You can also use the dimensions field to generate the HTML srcset property:

<img
  src="https://example.org/product-full.jpg"
  srcset="
    https://example.org/product-thumb.jpg   90w,
    https://example.org/product-full.jpg   600w,
    https://example.org/product-zoom.jpg  3000w
  "
/>

Using Asset Sources for offering a video in different encodings

In this example, the video is encoded for in MP4, WebM, and HTTP Live Streaming (HLS). A thumbnail is also available.

{
  "assetId": "<id>",
  "name": { "en": "My Product Video" },
  "sources": [
    {
      "uri": "https://example.org/product-video.mp4",
      "key": "flash",
      "contentType": "video/mp4"
    },
    {
      "uri": "https://example.org/product-video.webm",
      "key": "html5",
      "contentType": "video/webm"
    },
    {
      "uri": "https://example.org/product-video.m3u8",
      "key": "mobile",
      "contentType": "application/x-mpegURL"
    },
    {
      "uri": "https://example.org/product-video-thumb.jpg",
      "key": "thumb",
      "contentType": "application/jpeg"
    }
  ]
}

The flash player or a mobile app could look for its file by the key. In HTML5, the video element supports multiple sources and the browser will pick the most suitable source:

<video controls poster="https://example.org/product-video-thumb.jpg">
  <source src="https://example.org/product-video.mp4" type="video/mp4" />
  <source src="https://example.org/product-video.webm" type="video/webm" />
  <source
    src="https://example.org/product-video.m3u8"
    type="application/x-mpegURL"
  />
</video>

Conclusion

You've seen how to create a simple asset like a PDF, how a frontend can select the right asset out of multiple ones based on tags, and how asset sources can be used to offer different image resolutions or video encodings.