Adding delivery keys

Delivery keys are strings of up to 150 characters that can be used instead of the content id to retrieve content items and slots. The delivery key can be a simple string or a path such as "home-page/feature-banner". You can change the delivery key that is associated with a slot or content item, but the item must be republished before the updated key can be used to retrieve its content.

A hub must be enabled for Content Delivery 2 in order for the delivery key feature to be available.

Adding a delivery key

There are two ways of adding a delivery key to a slot or content item in the Dynamic Content app: from the item's menu in the Content Library or from the Save menu in the content editing window.

To add a delivery key from the content editing window, double-click the item in the Content Library and choose "Delivery key" from the Save menu.

In this example we're adding a delivery key to a slot, but you can add a delivery key to a content item in the same way.

To add a delivery key, choose Delivery key from the save menu
To add a delivery key, choose Delivery key from the save menu

Enter your chosen key in the Delivery key window. The key must be between 1 and 150 characters and follow the delivery key validation rules. The path delimiter "/" can be included in the key, but not as the first or last character.

In this example we are setting the delivery key to "home-page/main-feature-slot".

Click "Save" to assign the delivery key to the slot.

Ensure that the delivery key meets the validation rules
Ensure that the delivery key meets the validation rules

When the delivery key is saved, the properties pane is updated to include delivery URLs to get the slot by id and by delivery key. You will need to publish the slot before you can use the production delivery URLs.

The content item properties pane now includes a Content Delivery beta section
The content item properties pane now includes a Content Delivery beta section

With the slot published, the following URL can be used to get the slot using its delivery key:

https://ampproduct-doc.cdn.content.amplience.net/content/key/home-page/main-feature-slot?depth=all&format=inlined

Content item example

In this example we'll add a delivery key to the winter banner content item. One way to do this is to choose "Delivery key" from the item's menu in the Content Library. As shown in the slot example above, you can also add a delivery key from the content editing window.

You can also choose to add a delivery key to a content item or slot from its menu in the Content Library
You can also choose to add a delivery key to a content item or slot from its menu in the Content Library

For this example the delivery key is set to: "home-page/feature-promo-banner".

Adding a delivery key to the banner content item
Adding a delivery key to the banner content item

When the delivery key has been added, the URL to retrieve the item, using either its id or the delivery key, is shown in the properties pane. The content item must be published before it can be retrieved using the production delivery key URL.

The delivery URL to retrieve the item using either its id or delivery key is shown in the properties pane
The delivery URL to retrieve the item using either its id or delivery key is shown in the properties pane

The following URL will retrieve the banner content using its delivery key.

https://ampproduct-doc.cdn.content.amplience.net/content/key/home-page/feature-promo-banner?depth=all&format=inlined

Updating a delivery key

You can update a delivery key once it's set by just choosing "Delivery key" from the Save menu in the content editing window, or from the Content Library. In the example below we're changing the key to "promo-page/main-feature-slot" to change the location in which the slot is displayed. To delete a delivery key, just enter an empty string.

If you update a delivery key you will need to republish the content item or slot
If you update a delivery key you will need to republish the content item or slot

A content item or slot can only be retrieved using an updated delivery key, once it's been re-published.

results matching ""

    No results matching ""