Reference documentation and code samples for the Google Ads Ad Manager V1 Client class DaiEncodingProfile.
A DaiEncodingProfile contains data about a publisher's encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video.
Generated from protobuf message google.ads.admanager.v1.DaiEncodingProfile
Namespace
Google \ Ads \ AdManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the |
↳ display_name |
string
Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character. |
↳ status |
int
Output only. The status of this DaiEncodingProfile. DAI encoding profiles are created in the DaiEncodingProfileStatus.ACTIVE state by default. Only active profiles will be allowed to be associated with live streams. |
↳ variant_type |
int
Required. The variant playlist type that this DaiEncodingProfile represents. |
↳ container_type |
int
Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types. |
↳ video_settings |
VideoSettings
Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type. |
↳ audio_settings |
AudioSettings
Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio. |
getName
Identifier. The resource name of the DaiEncodingProfile.
Format:
networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The resource name of the DaiEncodingProfile.
Format:
networks/{network_code}/daiEncodingProfiles/{dai_encoding_profile_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayName
clearDisplayName
setDisplayName
Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. The status of this DaiEncodingProfile.
DAI encoding profiles are created in the DaiEncodingProfileStatus.ACTIVE state by default. Only active profiles will be allowed to be associated with live streams.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStatus
clearStatus
setStatus
Output only. The status of this DaiEncodingProfile.
DAI encoding profiles are created in the DaiEncodingProfileStatus.ACTIVE state by default. Only active profiles will be allowed to be associated with live streams.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVariantType
Required. The variant playlist type that this DaiEncodingProfile represents.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasVariantType
clearVariantType
setVariantType
Required. The variant playlist type that this DaiEncodingProfile represents.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContainerType
Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasContainerType
clearContainerType
setContainerType
Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVideoSettings
Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.
| Returns | |
|---|---|
| Type | Description |
VideoSettings|null |
|
hasVideoSettings
clearVideoSettings
setVideoSettings
Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.
| Parameter | |
|---|---|
| Name | Description |
var |
VideoSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAudioSettings
Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.
| Returns | |
|---|---|
| Type | Description |
AudioSettings|null |
|
hasAudioSettings
clearAudioSettings
setAudioSettings
Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.
| Parameter | |
|---|---|
| Name | Description |
var |
AudioSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|