class VAST::CompanionCreative

Commonly text, display ads, rich media, or skins that wrap around the video experience. These ads come in a number of sizes and shapes and typically run alongside or surrounding the video player.

Public Instance Methods

alt_text() click to toggle source

Alternate text to be displayed when companion is rendered in HTML environment.

# File lib/vast/companion_creative.rb, line 41
def alt_text
  node = source_node.at('AltText')
  node.nil? ? nil : node.content
end
api_framework() click to toggle source

Defines the method to use for communication with the companion

# File lib/vast/companion_creative.rb, line 31
def api_framework
  source_node[:apiFramework]
end
click_through_url() click to toggle source

URI to open as destination page when user clicks on the video

# File lib/vast/companion_creative.rb, line 36
def click_through_url
  URI.parse source_node.at('CompanionClickThrough').content.strip
end
creative_type() click to toggle source

Returns MIME type of static creative

# File lib/vast/companion_creative.rb, line 58
def creative_type
  if resource_type == :static
    source_node.at('StaticResource')[:creativeType]
  end
end
expanded_height() click to toggle source

Height in pixels of expanding companion ad when in expanded state

# File lib/vast/companion_creative.rb, line 26
def expanded_height
  source_node[:expandedHeight].to_i
end
expanded_width() click to toggle source

Width in pixels of expanding companion ad when in expanded state

# File lib/vast/companion_creative.rb, line 21
def expanded_width
  source_node[:expandedWidth].to_i
end
height() click to toggle source

Height in pixels of companion

# File lib/vast/companion_creative.rb, line 16
def height
  source_node[:height].to_i
end
id() click to toggle source
# File lib/vast/companion_creative.rb, line 6
def id
  source_node[:id]
end
resource_html() click to toggle source

Returns HTML text for html resource

# File lib/vast/companion_creative.rb, line 75
def resource_html
  if resource_type == :html
    source_node.at('HTMLResource').content
  end
end
resource_type() click to toggle source

Type of companion resource, returned as a symbol. Either :static, :iframe, or :html.

# File lib/vast/companion_creative.rb, line 47
def resource_type
  if source_node.at('StaticResource')
    :static
  elsif source_node.at('IFrameResource')
    :iframe
  elsif source_node.at('HTMLResource')
    :html
  end
end
resource_url() click to toggle source

Returns URI for static or iframe resource

# File lib/vast/companion_creative.rb, line 65
def resource_url
  case resource_type
  when :static
    URI.parse source_node.at('StaticResource').content.strip
  when :iframe
    URI.parse source_node.at('IFrameResource').content.strip
  end
end
width() click to toggle source

Width in pixels of companion

# File lib/vast/companion_creative.rb, line 11
def width
  source_node[:width].to_i
end