Reference documentation and code samples for the Google Ads Ad Manager V1 Client class LinearInfo.
The LiveStream resource in the stream request that creates the DAI session.
Generated from protobuf message google.ads.admanager.v1.DaiSession.CreationContext.LinearInfo
Namespace
Google \ Ads \ AdManager \ V1 \ DaiSession \ CreationContextMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ live_stream |
string
Output only. The name field of the LiveStream resource. |
↳ asset_key |
string
Output only. The LiveStream.asset_key field. Google Ad Manager only generates this field for livestreams with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value. |
↳ custom_asset_key |
string
Output only. The LiveStream.custom_asset_key field. This field is only populated for livestreams with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.POD_SERVING_MANIFEST value or DynamicAdInsertionType.POD_SERVING_REDIRECT value. |
↳ prefetch_enabled |
bool
Output only. Whether the LiveStream.prefetch_enabled field is set to true. |
↳ pod_trimming_enabled |
bool
Output only. Whether ad pod trimming is enabled for the DAI session. |
↳ pod_trim_tolerance |
Google\Protobuf\Duration
Optional. The maximum duration allowed to be trimmed from an ad pod before whole ads are dropped. This field is only populated when pod trimming is enabled. |
↳ event_start_time |
Google\Protobuf\Timestamp
The LiveStream.start_time field. |
↳ event_end_time |
Google\Protobuf\Timestamp
Output only. The LiveStream.end_time field. |
getLiveStream
Output only. The name field of the LiveStream resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasLiveStream
clearLiveStream
setLiveStream
Output only. The name field of the LiveStream resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssetKey
Output only. The LiveStream.asset_key field. Google Ad Manager only generates this field for livestreams with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAssetKey
clearAssetKey
setAssetKey
Output only. The LiveStream.asset_key field. Google Ad Manager only generates this field for livestreams with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.LINEAR value.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomAssetKey
Output only. The LiveStream.custom_asset_key field. This field is only populated for livestreams with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.POD_SERVING_MANIFEST value or DynamicAdInsertionType.POD_SERVING_REDIRECT value.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCustomAssetKey
clearCustomAssetKey
setCustomAssetKey
Output only. The LiveStream.custom_asset_key field. This field is only populated for livestreams with the dynamic_ad_insertion_type field set to DynamicAdInsertionType.POD_SERVING_MANIFEST value or DynamicAdInsertionType.POD_SERVING_REDIRECT value.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrefetchEnabled
Output only. Whether the LiveStream.prefetch_enabled field is set to true.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasPrefetchEnabled
clearPrefetchEnabled
setPrefetchEnabled
Output only. Whether the LiveStream.prefetch_enabled field is set to true.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPodTrimmingEnabled
Output only. Whether ad pod trimming is enabled for the DAI session.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasPodTrimmingEnabled
clearPodTrimmingEnabled
setPodTrimmingEnabled
Output only. Whether ad pod trimming is enabled for the DAI session.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPodTrimTolerance
Optional. The maximum duration allowed to be trimmed from an ad pod before whole ads are dropped. This field is only populated when pod trimming is enabled.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasPodTrimTolerance
clearPodTrimTolerance
setPodTrimTolerance
Optional. The maximum duration allowed to be trimmed from an ad pod before whole ads are dropped. This field is only populated when pod trimming is enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventStartTime
The LiveStream.start_time field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEventStartTime
clearEventStartTime
setEventStartTime
The LiveStream.start_time field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventEndTime
Output only. The LiveStream.end_time field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasEventEndTime
clearEventEndTime
setEventEndTime
Output only. The LiveStream.end_time field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|