Video Stitcher V1 API - Class Google::Cloud::Video::Stitcher::V1::Companion (v1.1.0)

Reference documentation and code samples for the Video Stitcher V1 API class Google::Cloud::Video::Stitcher::V1::Companion.

Metadata for a companion.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#ad_slot_id

def ad_slot_id() -> ::String

Returns

(::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.

#ad_slot_id=

def ad_slot_id=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#api_framework

def api_framework() -> ::String

Returns

(::String) — The API necessary to communicate with the creative if available.

#api_framework=

def api_framework=(value) -> ::String

Parameter

value (::String) — The API necessary to communicate with the creative if available.

Returns

(::String) — The API necessary to communicate with the creative if available.

#asset_height_px

def asset_height_px() -> ::Integer

Returns

(::Integer) — The pixel height of the creative.

#asset_height_px=

def asset_height_px=(value) -> ::Integer

Parameter

value (::Integer) — The pixel height of the creative.

Returns

(::Integer) — The pixel height of the creative.

#asset_width_px

def asset_width_px() -> ::Integer

Returns

(::Integer) — The pixel width of the creative.

#asset_width_px=

def asset_width_px=(value) -> ::Integer

Parameter

value (::Integer) — The pixel width of the creative.

Returns

(::Integer) — The pixel width of the creative.

#events

def events() -> ::Array<::Google::Cloud::Video::Stitcher::V1::Event>

Returns

(::Array<::Google::Cloud::Video::Stitcher::V1::Event>) — The list of tracking events for the companion.

#events=

def events=(value) -> ::Array<::Google::Cloud::Video::Stitcher::V1::Event>

Parameter

value (::Array<::Google::Cloud::Video::Stitcher::V1::Event>) — The list of tracking events for the companion.

Returns

(::Array<::Google::Cloud::Video::Stitcher::V1::Event>) — The list of tracking events for the companion.

#expanded_height_px

def expanded_height_px() -> ::Integer

Returns

(::Integer) — The maximum pixel height of the creative in its expanded state.

#expanded_height_px=

def expanded_height_px=(value) -> ::Integer

Parameter

value (::Integer) — The maximum pixel height of the creative in its expanded state.

Returns

(::Integer) — The maximum pixel height of the creative in its expanded state.

#expanded_width_px

def expanded_width_px() -> ::Integer

Returns

(::Integer) — The maximum pixel width of the creative in its expanded state.

#expanded_width_px=

def expanded_width_px=(value) -> ::Integer

Parameter

value (::Integer) — The maximum pixel width of the creative in its expanded state.

Returns

(::Integer) — The maximum pixel width of the creative in its expanded state.

#height_px

def height_px() -> ::Integer

Returns

(::Integer) — The pixel height of the placement slot for the intended creative.

#height_px=

def height_px=(value) -> ::Integer

Parameter

value (::Integer) — The pixel height of the placement slot for the intended creative.

Returns

(::Integer) — The pixel height of the placement slot for the intended creative.

#html_ad_resource

def html_ad_resource() -> ::Google::Cloud::Video::Stitcher::V1::HtmlAdResource

Returns

(::Google::Cloud::Video::Stitcher::V1::HtmlAdResource) — The HTML ad resource associated with the companion ad.

#html_ad_resource=

def html_ad_resource=(value) -> ::Google::Cloud::Video::Stitcher::V1::HtmlAdResource

Parameter

value (::Google::Cloud::Video::Stitcher::V1::HtmlAdResource) — The HTML ad resource associated with the companion ad.

Returns

(::Google::Cloud::Video::Stitcher::V1::HtmlAdResource) — The HTML ad resource associated with the companion ad.

#iframe_ad_resource

def iframe_ad_resource() -> ::Google::Cloud::Video::Stitcher::V1::IframeAdResource

Returns

(::Google::Cloud::Video::Stitcher::V1::IframeAdResource) — The IFrame ad resource associated with the companion ad.

#iframe_ad_resource=

def iframe_ad_resource=(value) -> ::Google::Cloud::Video::Stitcher::V1::IframeAdResource

Parameter

value (::Google::Cloud::Video::Stitcher::V1::IframeAdResource) — The IFrame ad resource associated with the companion ad.

Returns

(::Google::Cloud::Video::Stitcher::V1::IframeAdResource) — The IFrame ad resource associated with the companion ad.

#static_ad_resource

def static_ad_resource() -> ::Google::Cloud::Video::Stitcher::V1::StaticAdResource

Returns

(::Google::Cloud::Video::Stitcher::V1::StaticAdResource) — The static ad resource associated with the companion ad.

#static_ad_resource=

def static_ad_resource=(value) -> ::Google::Cloud::Video::Stitcher::V1::StaticAdResource

Parameter

value (::Google::Cloud::Video::Stitcher::V1::StaticAdResource) — The static ad resource associated with the companion ad.

Returns

(::Google::Cloud::Video::Stitcher::V1::StaticAdResource) — The static ad resource associated with the companion ad.

#width_px

def width_px() -> ::Integer

Returns

(::Integer) — The pixel width of the placement slot for the intended creative.

#width_px=

def width_px=(value) -> ::Integer

Parameter

value (::Integer) — The pixel width of the placement slot for the intended creative.

Returns

(::Integer) — The pixel width of the placement slot for the intended creative.