type SecurityPolicySettings (v202308)

Service
CdnConfigurationService
Dependencies
MediaLocationSettings
▼
SecurityPolicySettings

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.

Namespace
https://www.google.com/apis/ads/publisher/v202308

Field

securityPolicyType

SecurityPolicyType

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

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
NONE
Indicates that no authentication is necessary.
AKAMAI
Security policy for accessing content on the Akamai CDN.
CLOUD_MEDIA
Security policy for access content on Google Cloud Media CDN.

tokenAuthenticationKey

xsd:string

Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of securityPolicyType is equal to SecurityPolicyType.AKAMAI and will be set to null otherwise.

This field is required when the CdnConfiguration.cdnConfigurationType is equal to CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT and this SecurityPolicyDto is being configured for SourceContentConfiguration.ingestSettings.

disableServerSideUrlSigning

xsd:boolean

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

OriginForwardingType

The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to SecurityPolicyType.AKAMAI. If set elsewhere it will be reset to null.

Enumerations
ORIGIN_PATH
Indicates that origin forwarding is set up by passing an originpath query string parameter (necessary for Akamai dynamic packaging to work)
CONVENTIONAL
Indicates that conventional origin forwarding is used.
NONE
Indicates that origin forwarding is not being used.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

originPathPrefix

xsd:string

The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of originForwardingType set to OriginForwardingType.CONVENTIONAL, and will be set to null otherwise.

mediaPlaylistOriginForwardingType

OriginForwardingType

The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a cdnConfigurationType of CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT, is not applicable to ingest locations, and is only applicable to delivery media locations with the securityPolicyType set to SecurityPolicyType.AKAMAI. Valid options are OriginForwardingType#NONE or OriginForwardingType#ORIGIN_PATH.

This setting can only be used with CDN configurations with a cdnConfigurationType of CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT.

Enumerations
ORIGIN_PATH
Indicates that origin forwarding is set up by passing an originpath query string parameter (necessary for Akamai dynamic packaging to work)
CONVENTIONAL
Indicates that conventional origin forwarding is used.
NONE
Indicates that origin forwarding is not being used.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

mediaPlaylistOriginPathPrefix

xsd:string

The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of mediaPlaylistOriginForwardingType set to OriginForwardingType.CONVENTIONAL, and will be set to null otherwise.

keysetName

xsd:string

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

signedRequestExpirationTtlSeconds

xsd:long

The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.