All Implemented Interfaces:

@ApiStatus.Experimental() 
public final class AdInit

An initializer for a custom Ad.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`type`
`private Integer`	`timeOffset`
`private Integer`	`skipOffset`
`private String`	`id`
`private Integer`	`duration`
`private String`	`clickThrough`
`private String`	`resourceURI`
`private List<MediaFile>`	`mediaFiles`
`private Object`	`customData`

Constructor Summary

Constructors
Constructor	Description
`AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles, Object customData)`
`AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles)`
`AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI)`
`AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough)`
`AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration)`
`AdInit(String type, Integer timeOffset, Integer skipOffset, String id)`
`AdInit(String type, Integer timeOffset, Integer skipOffset)`
`AdInit(String type, Integer timeOffset)`
`AdInit(String type)`
`AdInit()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getType()`	The type of the ad.
`final Unit`	`setType(String type)`	The type of the ad.
`final Integer`	`getTimeOffset()`	The time offset at which content will be paused to play the ad, in seconds.
`final Unit`	`setTimeOffset(Integer timeOffset)`	The time offset at which content will be paused to play the ad, in seconds.
`final Integer`	`getSkipOffset()`	The number of seconds after which the ad can be skipped, in seconds.
`final Unit`	`setSkipOffset(Integer skipOffset)`	The number of seconds after which the ad can be skipped, in seconds.
`final String`	`getId()`	The identifier of the ad.
`final Unit`	`setId(String id)`	The identifier of the ad.
`final Integer`	`getDuration()`	The duration of the ad, in seconds.
`final Unit`	`setDuration(Integer duration)`	The duration of the ad, in seconds.
`final String`	`getClickThrough()`	The website of the advertiser.
`final Unit`	`setClickThrough(String clickThrough)`	The website of the advertiser.
`final String`	`getResourceURI()`	The URI of the the ad content.
`final Unit`	`setResourceURI(String resourceURI)`	The URI of the the ad content.
`final List<MediaFile>`	`getMediaFiles()`	The list of media files which contain metadata about ad video files.
`final Unit`	`setMediaFiles(List<MediaFile> mediaFiles)`	The list of media files which contain metadata about ad video files.
`final Object`	`getCustomData()`	Additional integration-specific data associated with this ad.
`final Unit`	`setCustomData(Object customData)`	Additional integration-specific data associated with this ad.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles, Object customData)

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI, List<MediaFile> mediaFiles)

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough, String resourceURI)

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration, String clickThrough)

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset, String id, Integer duration)

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset, String id)

AdInit

AdInit(String type, Integer timeOffset, Integer skipOffset)

AdInit
```
AdInit(String type, Integer timeOffset)
```

AdInit
```
AdInit(String type)
```

AdInit
```
AdInit()
```

Method Detail
- getType
```
 final String getType()
```
  The type of the ad.
  - Can be either 'linear' or 'nonlinear'.
- setType
```
 final Unit setType(String type)
```
  The type of the ad.
  - Can be either 'linear' or 'nonlinear'.
- getTimeOffset
```
 final Integer getTimeOffset()
```
  The time offset at which content will be paused to play the ad, in seconds.
  - Optional when used in ServerSideAdIntegrationController.createAd with an existing AdBreak.
- setTimeOffset
```
 final Unit setTimeOffset(Integer timeOffset)
```
  The time offset at which content will be paused to play the ad, in seconds.
  - Optional when used in ServerSideAdIntegrationController.createAd with an existing AdBreak.
- getSkipOffset
```
 final Integer getSkipOffset()
```
  The number of seconds after which the ad can be skipped, in seconds.
- setSkipOffset
```
 final Unit setSkipOffset(Integer skipOffset)
```
  The number of seconds after which the ad can be skipped, in seconds.
- getId
```
 final String getId()
```
  The identifier of the ad.
- setId
```
 final Unit setId(String id)
```
  The identifier of the ad.
- getDuration
```
 final Integer getDuration()
```
  The duration of the ad, in seconds.
  - Only applicable to linear ads.
- setDuration
```
 final Unit setDuration(Integer duration)
```
  The duration of the ad, in seconds.
  - Only applicable to linear ads.
- getClickThrough
```
 final String getClickThrough()
```
  The website of the advertiser.
- setClickThrough
```
 final Unit setClickThrough(String clickThrough)
```
  The website of the advertiser.
- getResourceURI
```
 final String getResourceURI()
```
  The URI of the the ad content.
- setResourceURI
```
 final Unit setResourceURI(String resourceURI)
```
  The URI of the the ad content.
- getMediaFiles
```
 final List<MediaFile> getMediaFiles()
```
  The list of media files which contain metadata about ad video files.
  - Only applicable to linear ads.
- setMediaFiles
```
 final Unit setMediaFiles(List<MediaFile> mediaFiles)
```
  The list of media files which contain metadata about ad video files.
  - Only applicable to linear ads.
- getCustomData
```
 final Object getCustomData()
```
  Additional integration-specific data associated with this ad.
- setCustomData
```
 final Unit setCustomData(Object customData)
```
  Additional integration-specific data associated with this ad.

Class AdInit

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdInit

AdInit

AdInit

AdInit

AdInit

AdInit

AdInit

AdInit

AdInit

AdInit

Method Detail

getType

setType

getTimeOffset

setTimeOffset

getSkipOffset

setSkipOffset

getId

setId

getDuration

setDuration

getClickThrough

setClickThrough

getResourceURI

setResourceURI

getMediaFiles

setMediaFiles

getCustomData

setCustomData