Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class Companion.
Metadata for a companion.
Generated from protobuf message google.cloud.video.stitcher.v1.Companion
Namespace
Google \ Cloud \ Video \ Stitcher \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ iframe_ad_resource
Google\Cloud\Video\Stitcher\V1\IframeAdResource
The IFrame ad resource associated with the companion ad.
↳ static_ad_resource
Google\Cloud\Video\Stitcher\V1\StaticAdResource
The static ad resource associated with the companion ad.
↳ html_ad_resource
Google\Cloud\Video\Stitcher\V1\HtmlAdResource
The HTML ad resource associated with the companion ad.
↳ api_framework
string
The API necessary to communicate with the creative if available.
↳ height_px
int
The pixel height of the placement slot for the intended creative.
↳ width_px
int
The pixel width of the placement slot for the intended creative.
↳ asset_height_px
int
The pixel height of the creative.
↳ expanded_height_px
int
The maximum pixel height of the creative in its expanded state.
↳ asset_width_px
int
The pixel width of the creative.
↳ expanded_width_px
int
The maximum pixel width of the creative in its expanded state.
↳ ad_slot_id
string
The ID used to identify the desired placement on a publisher's page. Values to be used should be discussed between publishers and advertisers.
↳ events
getIframeAdResource
The IFrame ad resource associated with the companion ad.
hasIframeAdResource
setIframeAdResource
The IFrame ad resource associated with the companion ad.
$this
getStaticAdResource
The static ad resource associated with the companion ad.
hasStaticAdResource
setStaticAdResource
The static ad resource associated with the companion ad.
$this
getHtmlAdResource
The HTML ad resource associated with the companion ad.
hasHtmlAdResource
setHtmlAdResource
The HTML ad resource associated with the companion ad.
$this
getApiFramework
The API necessary to communicate with the creative if available.
string
setApiFramework
The API necessary to communicate with the creative if available.
var
string
$this
getHeightPx
The pixel height of the placement slot for the intended creative.
int
setHeightPx
The pixel height of the placement slot for the intended creative.
var
int
$this
getWidthPx
The pixel width of the placement slot for the intended creative.
int
setWidthPx
The pixel width of the placement slot for the intended creative.
var
int
$this
getAssetHeightPx
The pixel height of the creative.
int
setAssetHeightPx
The pixel height of the creative.
var
int
$this
getExpandedHeightPx
The maximum pixel height of the creative in its expanded state.
int
setExpandedHeightPx
The maximum pixel height of the creative in its expanded state.
var
int
$this
getAssetWidthPx
The pixel width of the creative.
int
setAssetWidthPx
The pixel width of the creative.
var
int
$this
getExpandedWidthPx
The maximum pixel width of the creative in its expanded state.
int
setExpandedWidthPx
The maximum pixel width of the creative in its expanded state.
var
int
$this
getAdSlotId
The ID used to identify the desired placement on a publisher's page.
Values to be used should be discussed between publishers and advertisers.
string
setAdSlotId
The ID used to identify the desired placement on a publisher's page.
Values to be used should be discussed between publishers and advertisers.
var
string
$this
getEvents
The list of tracking events for the companion.
setEvents
The list of tracking events for the companion.
$this
getAdResource
string
