UpdateAdInsertion - Intelligent Media Services - Alibaba Cloud Documentation Center

Modifies an ad insertion configuration.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:UpdateAdInsertion	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The configuration name, which cannot be modified.	my_ad
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 that specifies the player parameter variables and aliases. Format: { "player_params.{name}": { "{key}": "{value}" } }. You can add up to 20 player_params.{name} entries. The name field can be up to 150 characters in length. Each player parameter can include up to 50 key-value pairs. A key can be up to 150 characters long, and a value can be up to 500 characters.	{ "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	Specifies whether to enable ad marker passthrough. Default value: OFF. Valid values: OFF: Disable. ON: Enable.	ON
PersonalizationThreshold	integer	No	Specifies the maximum duration of underfilled time 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 parameters

Parameter	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/
RequestId	string	The ID of the request.	**63E8B7C7-4812-46AD-0FA56029AC86**

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.