Class: Google::Cloud::Video::Stitcher::V1::Companion

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/stitcher/v1/companions.rb

Overview

Metadata for a companion.

Instance Attribute Summary collapse

Instance Attribute Details

#ad_slot_id ⇒ ::String

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



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#api_framework ⇒ ::String

Returns The API necessary to communicate with the creative if available.

Returns:

  • (::String) —

    The API necessary to communicate with the creative if available.



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#asset_height_px ⇒ ::Integer

Returns The pixel height of the creative.

Returns:

  • (::Integer) —

    The pixel height of the creative.



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#asset_width_px ⇒ ::Integer

Returns The pixel width of the creative.

Returns:

  • (::Integer) —

    The pixel width of the creative.



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#events ⇒ ::Array<::Google::Cloud::Video::Stitcher::V1::Event>

Returns The list of tracking events for the companion.

Returns:



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#expanded_height_px ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#expanded_width_px ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#height_px ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#html_ad_resource ⇒ ::Google::Cloud::Video::Stitcher::V1::HtmlAdResource

Returns The HTML ad resource associated with the companion ad.

Note: The following fields are mutually exclusive: html_ad_resource, iframe_ad_resource, static_ad_resource. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::Stitcher::V1::HtmlAdResource) —

    The HTML ad resource associated with the companion ad.

    Note: The following fields are mutually exclusive: html_ad_resource, iframe_ad_resource, static_ad_resource. If a field in that set is populated, all other fields in the set will automatically be cleared.



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#iframe_ad_resource ⇒ ::Google::Cloud::Video::Stitcher::V1::IframeAdResource

Returns The IFrame ad resource associated with the companion ad.

Note: The following fields are mutually exclusive: iframe_ad_resource, static_ad_resource, html_ad_resource. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::Stitcher::V1::IframeAdResource) —

    The IFrame ad resource associated with the companion ad.

    Note: The following fields are mutually exclusive: iframe_ad_resource, static_ad_resource, html_ad_resource. If a field in that set is populated, all other fields in the set will automatically be cleared.



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#static_ad_resource ⇒ ::Google::Cloud::Video::Stitcher::V1::StaticAdResource

Returns The static ad resource associated with the companion ad.

Note: The following fields are mutually exclusive: static_ad_resource, iframe_ad_resource, html_ad_resource. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::Stitcher::V1::StaticAdResource) —

    The static ad resource associated with the companion ad.

    Note: The following fields are mutually exclusive: static_ad_resource, iframe_ad_resource, html_ad_resource. If a field in that set is populated, all other fields in the set will automatically be cleared.



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#width_px ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



97
98
99
100
 
# File 'proto_docs/google/cloud/video/stitcher/v1/companions.rb', line 97

class Companion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end