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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\IframeAdResource|null | |
hasIframeAdResource
setIframeAdResource
The IFrame ad resource associated with the companion ad.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\IframeAdResource
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStaticAdResource
The static ad resource associated with the companion ad.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\StaticAdResource|null | |
hasStaticAdResource
setStaticAdResource
The static ad resource associated with the companion ad.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\StaticAdResource
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHtmlAdResource
The HTML ad resource associated with the companion ad.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\HtmlAdResource|null | |
hasHtmlAdResource
setHtmlAdResource
The HTML ad resource associated with the companion ad.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\HtmlAdResource
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApiFramework
The API necessary to communicate with the creative if available.
| Returns | |
|---|---|
| Type | Description |
string | |
setApiFramework
The API necessary to communicate with the creative if available.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHeightPx
The pixel height of the placement slot for the intended creative.
| Returns | |
|---|---|
| Type | Description |
int | |
setHeightPx
The pixel height of the placement slot for the intended creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWidthPx
The pixel width of the placement slot for the intended creative.
| Returns | |
|---|---|
| Type | Description |
int | |
setWidthPx
The pixel width of the placement slot for the intended creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAssetHeightPx
The pixel height of the creative.
| Returns | |
|---|---|
| Type | Description |
int | |
setAssetHeightPx
The pixel height of the creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpandedHeightPx
The maximum pixel height of the creative in its expanded state.
| Returns | |
|---|---|
| Type | Description |
int | |
setExpandedHeightPx
The maximum pixel height of the creative in its expanded state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAssetWidthPx
The pixel width of the creative.
| Returns | |
|---|---|
| Type | Description |
int | |
setAssetWidthPx
The pixel width of the creative.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpandedWidthPx
The maximum pixel width of the creative in its expanded state.
| Returns | |
|---|---|
| Type | Description |
int | |
setExpandedWidthPx
The maximum pixel width of the creative in its expanded state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEvents
The list of tracking events for the companion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEvents
The list of tracking events for the companion.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\Stitcher\V1\Event>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdResource
| Returns | |
|---|---|
| Type | Description |
string | |