All Products
Search

This Product

    Intelligent Media Services:AddAdInsertion

    Document Center

    Intelligent Media Services:AddAdInsertion

    Last Updated:Aug 28, 2026

    Adds an ad insertion configuration.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ice:AddAdInsertion

    create

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Name

    string

    Yes

    The configuration name. Must be unique, up to 128 characters in length. Letters, digits, underscores (_), and hyphens (-) are supported.

    my_ad
    ClientToken

    string

    No

    The idempotency key used to prevent repeated submissions. The value can be up to 200 characters in length.

    ****0311a423d11a5f7dee713535****
    ContentUrlPrefix

    string

    Yes

    The URL prefix for the source content. HTTP and HTTPS are supported. The maximum length is 512 characters.

    https://source.com/
    SlateAdUrl

    string

    No

    The HTTP or HTTPS URL of the slate ad. Only MP4 format is supported. The maximum length is 2,048 characters.

    http://storage.com/slate1.mp4
    ConfigAliases

    string

    No

    A JSON string of player parameter variables and aliases. Up to 20 player_params.{name} entries are supported. The name field can be up to 150 characters in length. Each player parameter supports up to 50 key-value pairs. A key can be up to 150 characters long, and a value can be up to 500 characters. Example: { "player_params.{name}": { "{key}": "{value}" } }

    { "player_params.p1": { "1": "abc" } }
    CdnContentSegmentUrlPrefix

    string

    No

    The CDN prefix for content segments. HTTP and HTTPS are supported. The maximum length is 512 characters.

    http://cdn.com/
    CdnAdSegmentUrlPrefix

    string

    No

    The CDN prefix for ad segments. HTTP and HTTPS are supported. The maximum length is 512 characters.

    http://cdn.com/
    AdMarkerPassthrough

    string

    No

    Whether to enable ad marker passthrough. Default value: OFF.

    Valid values:

    • OFF: Disable.

    • ON: Enable.

    Valid values:

    • OFF :
    • ON :

    ON
    PersonalizationThreshold

    integer

    No

    The maximum underfilled duration allowed in an ad break. Unit: seconds. Default value: 8 seconds.

    5
    AdsUrl

    string

    Yes

    The request URL of the ad decision server (ADS). HTTP and HTTPS are supported. The maximum length is 2,048 characters.

    http://ads.com/ad1?param1=[palyer_params.p1]

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    Config

    object

    The ad insertion configuration.

    CreateTime

    string

    The time when the configuration was created.

    2024-06-13T08:26:09Z
    LastModified

    string

    The time when the configuration was last modified.

    2024-06-13T08:26:09Z

    Name

    string

    The name of the ad insertion configuration.

    my_ad
    ContentUrlPrefix

    string

    The URL prefix for the source content.

    https://source.com/

    AdsUrl

    string

    The request URL of ADS.

    http://ads.com/ad1?param1=[palyer_params.p1]

    ConfigAliases

    string

    The player parameter variables and aliases.

    { "player_params.p1": { "1": "abc" } }

    PersonalizationThreshold

    integer

    The personalization threshold.

    5
    SlateAdUrl

    string

    The URL of the slate ad.

    http://storage.com/slate1.mp4

    CdnConfig

    object

    The CDN configurations.

    ContentSegmentUrlPrefix

    string

    The CDN prefix for content segments.

    http://cdn.com/

    AdSegmentUrlPrefix

    string

    The CDN prefix for ad segments.

    http://cdn.com/

    AdMarkerPassthrough

    string

    Indicates whether ad marker passthrough is enabled.

    ON
    ManifestEndpointConfig

    object

    The playback endpoint configuration.

    HlsPrefix

    string

    The prefix of the playback endpoint for HLS manifests.

    https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/

    DashPrefix

    string

    The prefix of the playback endpoint for DASH manifests.

    https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/
    RequestId

    string

    The ID of the request.

    ******3B-0E1A-586A-AC29-742247******

    Examples

    Success response

    JSON format

    {
  "Config": {
    "CreateTime": "2024-06-13T08:26:09Z",
    "LastModified": "2024-06-13T08:26:09Z\n",
    "Name": "my_ad",
    "ContentUrlPrefix": "https://source.com/\n",
    "AdsUrl": "http://ads.com/ad1?param1=[palyer_params.p1]\n",
    "ConfigAliases": "{ \"player_params.p1\": { \"1\": \"abc\" } }\n",
    "PersonalizationThreshold": 5,
    "SlateAdUrl": "http://storage.com/slate1.mp4\n",
    "CdnConfig": {
      "ContentSegmentUrlPrefix": "http://cdn.com/\n",
      "AdSegmentUrlPrefix": "http://cdn.com/\n"
    },
    "AdMarkerPassthrough": "ON",
    "ManifestEndpointConfig": {
      "HlsPrefix": "https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/\n",
      "DashPrefix": "https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/"
    }
  },
  "RequestId": "******3B-0E1A-586A-AC29-742247******"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.