Interface CompanionOrBuilder (0.3.3)

Version 0.3.3

• 0.54.0 (latest)
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.6
• 0.1.2

public interface CompanionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdResourceCase()

public abstract Companion.AdResourceCase getAdResourceCase()

Returns

Type	Description
Companion.AdResourceCase

getAdSlotId()

public abstract String 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.

string ad_slot_id = 8;

Returns

Type	Description
String	The adSlotId.

getAdSlotIdBytes()

public abstract ByteString getAdSlotIdBytes()

The ID used to identify the desired placement on a publisher's page. Values to be used should be discussed between publishers and advertisers.

string ad_slot_id = 8;

Returns

Type	Description
ByteString	The bytes for adSlotId.

getApiFramework()

public abstract String getApiFramework()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns

Type	Description
String	The apiFramework.

getApiFrameworkBytes()

public abstract ByteString getApiFrameworkBytes()

The API necessary to communicate with the creative if available.

string api_framework = 1;

Returns

Type	Description
ByteString	The bytes for apiFramework.

getAssetHeightPx()

public abstract int getAssetHeightPx()

The pixel height of the creative.

int32 asset_height_px = 4;

Returns

Type	Description
int	The assetHeightPx.

getAssetWidthPx()

public abstract int getAssetWidthPx()

The pixel width of the creative.

int32 asset_width_px = 6;

Returns

Type	Description
int	The assetWidthPx.

getEvents(int index)

public abstract Event getEvents(int index)

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
Event

getEventsCount()

public abstract int getEventsCount()

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Returns

Type	Description
int

getEventsList()

public abstract List<Event> getEventsList()

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Returns

Type	Description
List<Event>

getEventsOrBuilder(int index)

public abstract EventOrBuilder getEventsOrBuilder(int index)

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Parameter

Name	Description
index	int

Returns

Type	Description
EventOrBuilder

getEventsOrBuilderList()

public abstract List<? extends EventOrBuilder> getEventsOrBuilderList()

The list of tracking events for the companion.

repeated .google.cloud.video.stitcher.v1.Event events = 9;

Returns

Type	Description
List<? extends com.google.cloud.video.stitcher.v1.EventOrBuilder>

getExpandedHeightPx()

public abstract int getExpandedHeightPx()

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

int32 expanded_height_px = 5;

Returns

Type	Description
int	The expandedHeightPx.

getExpandedWidthPx()

public abstract int getExpandedWidthPx()

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

int32 expanded_width_px = 7;

Returns

Type	Description
int	The expandedWidthPx.

getHeightPx()

public abstract int getHeightPx()

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

int32 height_px = 2;

Returns

Type	Description
int	The heightPx.

getHtmlAdResource()

public abstract HtmlAdResource getHtmlAdResource()

The HTML ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;

Returns

Type	Description
HtmlAdResource	The htmlAdResource.

getHtmlAdResourceOrBuilder()

public abstract HtmlAdResourceOrBuilder getHtmlAdResourceOrBuilder()

The HTML ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;

Returns

Type	Description
HtmlAdResourceOrBuilder

getIframeAdResource()

public abstract IframeAdResource getIframeAdResource()

The IFrame ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;

Returns

Type	Description
IframeAdResource	The iframeAdResource.

getIframeAdResourceOrBuilder()

public abstract IframeAdResourceOrBuilder getIframeAdResourceOrBuilder()

The IFrame ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;

Returns

Type	Description
IframeAdResourceOrBuilder

getStaticAdResource()

public abstract StaticAdResource getStaticAdResource()

The static ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;

Returns

Type	Description
StaticAdResource	The staticAdResource.

getStaticAdResourceOrBuilder()

public abstract StaticAdResourceOrBuilder getStaticAdResourceOrBuilder()

The static ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;

Returns

Type	Description
StaticAdResourceOrBuilder

getWidthPx()

public abstract int getWidthPx()

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

int32 width_px = 3;

Returns

Type	Description
int	The widthPx.

hasHtmlAdResource()

public abstract boolean hasHtmlAdResource()

The HTML ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.HtmlAdResource html_ad_resource = 12;

Returns

Type	Description
boolean	Whether the htmlAdResource field is set.

hasIframeAdResource()

public abstract boolean hasIframeAdResource()

The IFrame ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.IframeAdResource iframe_ad_resource = 10;

Returns

Type	Description
boolean	Whether the iframeAdResource field is set.

hasStaticAdResource()

public abstract boolean hasStaticAdResource()

The static ad resource associated with the companion ad.

.google.cloud.video.stitcher.v1.StaticAdResource static_ad_resource = 11;

Returns

Type	Description
boolean	Whether the staticAdResource field is set.