Method Detail

• spotxAdDescription

  public static SpotXAdDescription.Builder spotxAdDescription()

  Creates a builder for SpotXAdDescription.

• spotxAdDescription

  public static SpotXAdDescription.Builder spotxAdDescription(SpotXAdDescription spotXAdDescription)

  Create a builder for SpotXAdDescription configured with SpotXAdDescription.

  Parameters:

  spotXAdDescription - The SpotXAdDescription. (NonNull)

• spotxAdDescription

  public static SpotXAdDescription.Builder spotxAdDescription(String id)

  Create a builder for SpotXAdDescription.

  Parameters:

  id - The identifier of the ad break requested from SpotX. (NonNull)

• id

  public SpotXAdDescription.Builder id(String id)

  Sets the identifier of the ad break requested from SpotX.

  Parameters:

  id - The identifier of the ad break. (NonNull)

• maximumAdDuration

  public SpotXAdDescription.Builder maximumAdDuration(String maximumAdDuration)

  Sets the maximum duration of the ad.

  Parameters:

  maximumAdDuration - The maximum duration of the ad, in seconds. (NonNull)

• ipAddress

  public SpotXAdDescription.Builder ipAddress(String ipAddress)

  Sets the IP address of the viewer.

  Parameters:

  ipAddress - The IP address of the viewer. (NonNull)

• cacheBuster

  public SpotXAdDescription.Builder cacheBuster(boolean cacheBuster)

  Sets whether the ad break request should contain a cache buster.

  Parameters:

  cacheBuster - Whether the ad break request should contain a cache buster.

• custom

  @Deprecated
  public SpotXAdDescription.Builder custom(SpotXAdDescription.SpotXData custom)

  Deprecated. Superseded by #queryParameters(SpotXDataQueryParameter) with SpotXDataQueryParameter.Builder#param(String, SpotXData).
  Custom SpotX data.

  Parameters:

  custom - The custom SpotX data. (NonNull)

  Example:

       - SpotXDataQueryParameter.Builder.spotxDataQueryParameters().param("custom", appSpotXData)
   

• app

  @Deprecated
  public SpotXAdDescription.Builder app(SpotXAdDescription.SpotXData app)

  Deprecated. Superseded by #queryParameters(SpotXDataQueryParameter) with SpotXDataQueryParameter.Builder#param(String, SpotXData).
  Application specific SpotX data.

  Parameters:

  app - The application specific SpotX data. (NonNull)

  Example:

       - SpotXDataQueryParameter.Builder.spotxDataQueryParameters().param("app", appSpotXData)
   

• device

  @Deprecated
  public SpotXAdDescription.Builder device(SpotXAdDescription.SpotXData device)

  Deprecated. Superseded by #queryParameters(SpotXDataQueryParameter) with SpotXDataQueryParameter.Builder#param(String, SpotXData).
  Device specific SpotX data.

  Parameters:

  device - The device specific SpotX data. (NonNull)

  Example:

       - SpotXDataQueryParameter.Builder.spotxDataQueryParameters().param("device", deviceSpotXData)
   

• user

  @Deprecated
  public SpotXAdDescription.Builder user(SpotXAdDescription.SpotXData user)

  Deprecated. Superseded by #queryParameters(SpotXDataQueryParameter) with SpotXDataQueryParameter.Builder#param(String, SpotXData).
  User specific SpotX data.

  Parameters:

  user - The user specific SpotX data. (NonNull)

  Example:

       - SpotXDataQueryParameter.Builder.spotxDataQueryParameters().param("user", userSpotXData)
   

• queryParameters

  public SpotXAdDescription.Builder queryParameters(SpotXAdDescription.SpotXDataQueryParameter queryParameters)

  Sets a record of query string parameters which are added to the SpotX ad break request. Each entry contains the parameter name with associated value.

  Parameters:

  queryParameters - The query string parameters. (NonNull)

• build

  public SpotXAdDescription build()

  Builds SpotXAdDescription.