REST Resource: networks.cdnConfigs

Resource: CdnConfig

A CdnConfig encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).

JSON representation 
{
  "name": string,
  "sourceContentConfig": {
    object (SourceContentConfig)
  },
  "adMediaDeliveryConfig": {
    object (AdMediaDeliveryConfig)
  },
  "displayName": string,
  "cdnConfigType": enum (CdnConfigType),
  "cdnConfigStatus": enum (CdnConfigStatus)
}
Fields
name

string

Identifier. The resource name of the CdnConfig. Format: networks/{networkCode}/cdnConfigs/{cdn_config_id}
sourceContentConfig

object (SourceContentConfig)

Optional. Parameters about this CDN config as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
adMediaDeliveryConfig

object (AdMediaDeliveryConfig)

Optional. Config of CDN to deliver ad media.
displayName

string

Required. The name of the CdnConfig. This value is required to create a CDN config and has a maximum length of 255 characters.
cdnConfigType

enum (CdnConfigType)

Required. The type of CDN config represented by this CdnConfig.
cdnConfigStatus

enum (CdnConfigStatus)

Output only. The status of the CDN config.

CdnConfigType

Indicates the type of CDN configuration for CdnConfiguration.

Enums
CDN_CONFIG_TYPE_UNSPECIFIED Default value. This value is unused.
AD_MEDIA_DELIVERY A configuration that specifies a publisher-provided CDN for delivering ad media.
LIVE_STREAM_SOURCE_CONTENT A configuration that specifies where and how LiveStreamEvent content should be ingested and delivered.
MIDROLL A configuration that specifies where and how split content should be uploaded and delivered.
VOD_SOURCE_CONTENT A configuration that specifies where and how video on demand content should be ingested and delivered.

SourceContentConfig

Parameters about this CDN config as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.

JSON representation 
{
  "ingestSettings": {
    object (MediaLocation)
  },
  "defaultDeliverySettings": {
    object (MediaLocation)
  }
}
Fields
ingestSettings

object (MediaLocation)

Required. Config for how DAI should ingest media. At ingest time, we match the URL prefix of media in a stream's playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content config.
defaultDeliverySettings

object (MediaLocation)

Required. Default config for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location's URL prefix with the delivery location's URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content config.

MediaLocation

Config that associates a media location with a security policy and the authentication credentials needed to access the content.

JSON representation 
{
  "securityPolicy": {
    object (CdnSecurityPolicy)
  },
  "displayName": string,
  "urlPrefix": string
}
Fields
securityPolicy

object (CdnSecurityPolicy)

Optional. The security policy and authentication credentials needed to access the content in this media location. Optional; if omitted, no security policy will be applied (indicating a public/unprotected location). Must NOT be configured for ad media delivery locations (doing so will trigger a validation error).
displayName

string

Output only. The name of the media location. This value is read-only and is assigned by Google.
urlPrefix

string

Required. The URL prefix of the media location. This value is required for a valid media location.

CdnSecurityPolicy

A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.

JSON representation 
{
  "securityPolicyType": enum (CdnSecurityPolicyType),
  "tokenAuthenticationKey": string,
  "serverSideUrlSigningDisabled": boolean,
  "originForwardingType": enum (CdnSecurityPolicyOriginForwarding),
  "originPathPrefix": string,
  "mediaPlaylistOriginForwardingType": enum (CdnSecurityPolicyOriginForwarding),
  "mediaPlaylistOriginPathPrefix": string,
  "keyset": string,
  "signedRequestExpirationTtl": string
}
Fields
securityPolicyType

enum (CdnSecurityPolicyType)

Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
tokenAuthenticationKey

string

Optional. Shared security key used to generate the Akamai HMAC token for authenticating requests. Only applicable when the value of CdnSecurityPolicyType is equal to CdnSecurityPolicyType.AKAMAI and will be set to null otherwise. Required when the CdnConfig.cdnConfigType is equal to CdnConfigType.LIVE_STREAM_SOURCE_CONTENT and this CdnSecurityPolicy is being configured for SourceContentConfig.ingestSettings.
serverSideUrlSigningDisabled

boolean

Optional. Whether the segment URLs should be signed using the #tokenAuthenticationKey on the server. This is only applicable for delivery media locations that have token authentication enabled.
originForwardingType

enum (CdnSecurityPolicyOriginForwarding)

Optional. The type of origin forwarding used to support Akamai authentication policies for the parent playlist. Not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to CdnSecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.
originPathPrefix

string

Optional. The origin path prefix provided by the publisher for the parent playlist. Only applicable for delivery media locations with the value of originForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.
mediaPlaylistOriginForwardingType

enum (CdnSecurityPolicyOriginForwarding)

Optional. The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the CdnSecurityPolicyType set to CdnSecurityPolicyType.AKAMAI. Valid options are CdnSecurityPolicyOriginForwarding.NONE or CdnSecurityPolicyOriginForwarding.ORIGIN_PATH. This setting can only be used with CDN configs with a cdnConfigType of CdnConfigType.LIVE_STREAM_SOURCE_CONTENT.
mediaPlaylistOriginPathPrefix

string

Optional. The origin path prefix provided by the publisher for the media playlists. Only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to CdnSecurityPolicyOriginForwarding.CONVENTIONAL, and will be set to null otherwise.
keyset

string

Optional. The name of the EdgeCacheKeyset on the Media CDN config that will be used to validate signed requests from DAI to ingest content.
signedRequestExpirationTtl

string (Duration format)

Optional. The duration for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN config.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

CdnSecurityPolicyType

Indicates the type of security policy associated with access to a CDN. Different security policies require different parameters in a SecurityPolicy.

Enums
CDN_SECURITY_POLICY_TYPE_UNSPECIFIED Default value. This value is unused.
AKAMAI Security policy for accessing content on the Akamai CDN.
CLOUD_MEDIA Security policy for access content on Google Cloud Media CDN.
NONE Indicates that no authentication is necessary.

CdnSecurityPolicyOriginForwarding

Indicates the type of origin forwarding used to support Akamai authentication policies for LiveStreamEvent.

Enums
CDN_SECURITY_POLICY_ORIGIN_FORWARDING_UNSPECIFIED Default value. This value is unused.
CONVENTIONAL Indicates that conventional origin forwarding is used.
NONE Indicates that origin forwarding is not being used.
ORIGIN_PATH Indicates that origin forwarding is set up by passing an origin path query string parameter (necessary for Akamai dynamic packaging to work).

AdMediaDeliveryConfig

Parameters about this CDN config of a CDN used for delivering ad media.

JSON representation 
{
  "deliverySettings": {
    object (MediaLocation)
  },
  "additionalDeliverySettings": [
    {
      object (MediaLocation)
    }
  ],
  "overrideDefaultDeliverySettings": boolean
}
Fields
deliverySettings

object (MediaLocation)

Optional. Config for the delivery location that will override the default. From MediaLocationDto, the URL prefix field represents the hostname of the external CDN and the security policy will be ignored. Null if overrideDefaultDeliverySettings is false.
additionalDeliverySettings[]

object (MediaLocation)

Optional. List of additional delivery locations. From MediaLocationDto, the URL prefix field represents the hostname of the external CDN and the security policy will be ignored. In your stream create request, you can set the value of the dai-dlid parameter to the name of the MediaLocation you want to use.
overrideDefaultDeliverySettings

boolean

Optional. Whether to override the default delivery CDN. If false, deliverySettings must be null.

CdnConfigStatus

Indicates the status of the CdnConfiguration.

Enums
CDN_CONFIG_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE The CDN configuration is in use.
ARCHIVED The CDN configuration is no longer used.

Methods

batchActivate

 Batch activates CdnConfig objects.

batchArchive

 Batch archives CdnConfig objects.

batchCreate

 Batch creates CdnConfig objects.

batchUpdate

 Batch updates CdnConfig objects.

create

 Creates a CdnConfig object.

get

 Retrieves a CdnConfig object.

list

 Lists CdnConfig objects.

patch

 Updates a CdnConfig object.