Google Ads Ad Manager V1 Client - Class CdnSecurityPolicy (0.8.0)

0.8.0 (latest) 0.7.0 0.6.2 0.5.0 0.4.1 0.3.1 0.2.0 0.1.3

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class 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.

Generated from protobuf message google.ads.admanager.v1.CdnSecurityPolicy

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ security_policy_type	int Required. Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
↳ token_authentication_key	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.
↳ server_side_url_signing_disabled	bool 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.
↳ origin_forwarding_type	int 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.
↳ origin_path_prefix	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.
↳ media_playlist_origin_forwarding_type	int 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.
↳ media_playlist_origin_path_prefix	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.
↳ signed_request_expiration_ttl	Google\Protobuf\Duration 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.

getSecurityPolicyType

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

Returns
Type	Description
int

hasSecurityPolicyType

clearSecurityPolicyType

setSecurityPolicyType

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTokenAuthenticationKey

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.

Returns
Type	Description
string

hasTokenAuthenticationKey

clearTokenAuthenticationKey

setTokenAuthenticationKey

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getServerSideUrlSigningDisabled

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.

Returns
Type	Description
bool

hasServerSideUrlSigningDisabled

clearServerSideUrlSigningDisabled

setServerSideUrlSigningDisabled

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getOriginForwardingType

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.

Returns
Type	Description
int

hasOriginForwardingType

clearOriginForwardingType

setOriginForwardingType

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getOriginPathPrefix

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.

Returns
Type	Description
string

hasOriginPathPrefix

clearOriginPathPrefix

setOriginPathPrefix

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMediaPlaylistOriginForwardingType

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.

Returns
Type	Description
int

hasMediaPlaylistOriginForwardingType

clearMediaPlaylistOriginForwardingType

setMediaPlaylistOriginForwardingType

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMediaPlaylistOriginPathPrefix

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.

Returns
Type	Description
string

hasMediaPlaylistOriginPathPrefix

clearMediaPlaylistOriginPathPrefix

setMediaPlaylistOriginPathPrefix

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getKeyset

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

Returns
Type	Description
string

hasKeyset

clearKeyset

setKeyset

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSignedRequestExpirationTtl

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.

Returns
Type	Description
Google\Protobuf\Duration|null

hasSignedRequestExpirationTtl

clearSignedRequestExpirationTtl

setSignedRequestExpirationTtl

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.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this