Google Ads Ad Manager V1 Client - Class CreationContext (0.14.1)

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class CreationContext.

Context data to create the DAI session.

Generated from protobuf message google.ads.admanager.v1.DaiSession.CreationContext

Namespace

Google \ Ads \ AdManager \ V1 \ DaiSession

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ linear_info CreationContext\LinearInfo

Output only. The LiveStream resource in the stream request that creates the DAI session.
↳ vod_info CreationContext\VodInfo

Output only. The Content resource in the stream request that creates the DAI session.
↳ debug_key string

Output only. The string the dai-sam-id parameter sets in the DAI stream request. For details, see Locate a DAI session ID or debug key.
↳ content_title string

Output only. The LiveStream.display_name field or Content.display_name field associated with the DAI session.
↳ session_title string

Output only. The string the session_title parameter sets in the DAI stream request. For details, see CreateStreamOptions.
↳ stream_create_request HttpRequest

Output only. The HTTP request creating the DAI session. For details, see Linear API, VOD API, pod serving live API and pod serving VOD API.
↳ stitching_type int

Output only. Whether the stream request is for Full-service DAI or Pod serving.
↳ reporting_type int

Output only. Whether ad tracking URLs are pinged on the client side or server side. If IMA SDK is used to make the stream requests, IMA SDK pings the ad tracking URLs on the client side. For server-side beaconing, see Integrate with DAI using server-side beaconing (SSB).
↳ interstitial_enabled bool

Output only. Whether the parameter dai-istl on the stream request is set to true. This parameter is only accepted for LiveStream resources with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.

getLinearInfo

Output only. The LiveStream resource in the stream request that creates the DAI session.

Returns
Type Description
CreationContext\LinearInfo|null

hasLinearInfo

setLinearInfo

Output only. The LiveStream resource in the stream request that creates the DAI session.

Parameter
Name Description
var CreationContext\LinearInfo
Returns
Type Description
$this

getVodInfo

Output only. The Content resource in the stream request that creates the DAI session.

Returns
Type Description
CreationContext\VodInfo|null

hasVodInfo

setVodInfo

Output only. The Content resource in the stream request that creates the DAI session.

Parameter
Name Description
var CreationContext\VodInfo
Returns
Type Description
$this

getDebugKey

Output only. The string the dai-sam-id parameter sets in the DAI stream request. For details, see Locate a DAI session ID or debug key.

Returns
Type Description
string

hasDebugKey

clearDebugKey

setDebugKey

Output only. The string the dai-sam-id parameter sets in the DAI stream request. For details, see Locate a DAI session ID or debug key.

Parameter
Name Description
var string
Returns
Type Description
$this

getContentTitle

Output only. The LiveStream.display_name field or Content.display_name field associated with the DAI session.

Returns
Type Description
string

hasContentTitle

clearContentTitle

setContentTitle

Output only. The LiveStream.display_name field or Content.display_name field associated with the DAI session.

Parameter
Name Description
var string
Returns
Type Description
$this

getSessionTitle

Output only. The string the session_title parameter sets in the DAI stream request. For details, see CreateStreamOptions.

Returns
Type Description
string

hasSessionTitle

clearSessionTitle

setSessionTitle

Output only. The string the session_title parameter sets in the DAI stream request. For details, see CreateStreamOptions.

Parameter
Name Description
var string
Returns
Type Description
$this

getStreamCreateRequest

Output only. The HTTP request creating the DAI session. For details, see Linear API, VOD API, pod serving live API and pod serving VOD API.

Returns
Type Description
HttpRequest|null

hasStreamCreateRequest

clearStreamCreateRequest

setStreamCreateRequest

Output only. The HTTP request creating the DAI session. For details, see Linear API, VOD API, pod serving live API and pod serving VOD API.

Parameter
Name Description
var HttpRequest
Returns
Type Description
$this

getStitchingType

Output only. Whether the stream request is for Full-service DAI or Pod serving.

Returns
Type Description
int

hasStitchingType

clearStitchingType

setStitchingType

Output only. Whether the stream request is for Full-service DAI or Pod serving.

Parameter
Name Description
var int
Returns
Type Description
$this

getReportingType

Output only. Whether ad tracking URLs are pinged on the client side or server side. If IMA SDK is used to make the stream requests, IMA SDK pings the ad tracking URLs on the client side. For server-side beaconing, see Integrate with DAI using server-side beaconing (SSB).

Returns
Type Description
int

hasReportingType

clearReportingType

setReportingType

Output only. Whether ad tracking URLs are pinged on the client side or server side. If IMA SDK is used to make the stream requests, IMA SDK pings the ad tracking URLs on the client side. For server-side beaconing, see Integrate with DAI using server-side beaconing (SSB).

Parameter
Name Description
var int
Returns
Type Description
$this

getInterstitialEnabled

Output only. Whether the parameter dai-istl on the stream request is set to true. This parameter is only accepted for LiveStream resources with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.

Returns
Type Description
bool

hasInterstitialEnabled

clearInterstitialEnabled

setInterstitialEnabled

Output only. Whether the parameter dai-istl on the stream request is set to true. This parameter is only accepted for LiveStream resources with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.

Parameter
Name Description
var bool
Returns
Type Description
$this

getContentInfo

Returns
Type Description
string