Google Cloud Video Stitcher V1 Client - Class Companion (0.7.3)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 array<Google\Cloud\Video\Stitcher\V1\Event>

The list of tracking events for the companion.

getIframeAdResource

The IFrame ad resource associated with the companion ad.

Returns
TypeDescription
Google\Cloud\Video\Stitcher\V1\IframeAdResource|null

hasIframeAdResource

setIframeAdResource

The IFrame ad resource associated with the companion ad.

Parameter
NameDescription
var Google\Cloud\Video\Stitcher\V1\IframeAdResource
Returns
TypeDescription
$this

getStaticAdResource

The static ad resource associated with the companion ad.

Returns
TypeDescription
Google\Cloud\Video\Stitcher\V1\StaticAdResource|null

hasStaticAdResource

setStaticAdResource

The static ad resource associated with the companion ad.

Parameter
NameDescription
var Google\Cloud\Video\Stitcher\V1\StaticAdResource
Returns
TypeDescription
$this

getHtmlAdResource

The HTML ad resource associated with the companion ad.

Returns
TypeDescription
Google\Cloud\Video\Stitcher\V1\HtmlAdResource|null

hasHtmlAdResource

setHtmlAdResource

The HTML ad resource associated with the companion ad.

Parameter
NameDescription
var Google\Cloud\Video\Stitcher\V1\HtmlAdResource
Returns
TypeDescription
$this

getApiFramework

The API necessary to communicate with the creative if available.

Returns
TypeDescription
string

setApiFramework

The API necessary to communicate with the creative if available.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHeightPx

The pixel height of the placement slot for the intended creative.

Returns
TypeDescription
int

setHeightPx

The pixel height of the placement slot for the intended creative.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getWidthPx

The pixel width of the placement slot for the intended creative.

Returns
TypeDescription
int

setWidthPx

The pixel width of the placement slot for the intended creative.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAssetHeightPx

The pixel height of the creative.

Returns
TypeDescription
int

setAssetHeightPx

The pixel height of the creative.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExpandedHeightPx

The maximum pixel height of the creative in its expanded state.

Returns
TypeDescription
int

setExpandedHeightPx

The maximum pixel height of the creative in its expanded state.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAssetWidthPx

The pixel width of the creative.

Returns
TypeDescription
int

setAssetWidthPx

The pixel width of the creative.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExpandedWidthPx

The maximum pixel width of the creative in its expanded state.

Returns
TypeDescription
int

setExpandedWidthPx

The maximum pixel width of the creative in its expanded state.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEvents

The list of tracking events for the companion.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEvents

The list of tracking events for the companion.

Parameter
NameDescription
var array<Google\Cloud\Video\Stitcher\V1\Event>
Returns
TypeDescription
$this

getAdResource

Returns
TypeDescription
string