com.yandex.mobile.ads.video

Class VideoAdRequest.Builder

java.lang.Object

com.yandex.mobile.ads.video.VideoAdRequest.Builder

Enclosing class:

VideoAdRequest

public static final class VideoAdRequest.Builder
extends java.lang.Object

Builds a new VideoAdRequest object.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context, BlocksInfo blocksInfo, RequestListener<java.util.List<VideoAd>> requestListener, java.lang.String targetRef, java.lang.String pageRef, java.lang.String blockId) Creates a new VideoAdRequest.Builder for constructing a VideoAdRequest

Method Summary

Modifier and Type	Method and Description
VideoAdRequest	build() Creates a VideoAdRequest with the arguments supplied to this builder.
VideoAdRequest.Builder	setCharset(VideoAdRequest.Charset charset)
VideoAdRequest.Builder	setContentId(java.lang.String contentId)
VideoAdRequest.Builder	setContentName(java.lang.String contentName)
VideoAdRequest.Builder	setExtendedParams(java.lang.String extendedParams)
VideoAdRequest.Builder	setGenreIds(java.util.List<java.lang.String> genreIds)
VideoAdRequest.Builder	setGenreNames(java.util.List<java.lang.String> genreNames)
VideoAdRequest.Builder	setMaxBitrate(int maxBitrate)
VideoAdRequest.Builder	setPlayerSize(int width, int height) Sets preferable video size in pixels
VideoAdRequest.Builder	setPublisherId(java.lang.String publisherId)
VideoAdRequest.Builder	setPublisherName(java.lang.String publisherName)
VideoAdRequest.Builder	setTagsList(java.util.List<java.lang.String> tagsList)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@NonNull
               android.content.Context context,
               @NonNull
               BlocksInfo blocksInfo,
               @Nullable
               RequestListener<java.util.List<VideoAd>> requestListener,
               @NonNull
               java.lang.String targetRef,
               @NonNull
               java.lang.String pageRef,
               @NonNull
               java.lang.String blockId)

Creates a new VideoAdRequest.Builder for constructing a VideoAdRequest

Parameters:

context - Interface to global information about an application environment

blocksInfo - a BlocksInfo, received in YandexVideoAds.loadBlocksInfo(BlocksInfoRequest)

requestListener - a listener to receive a List of downloaded VideoAds

targetRef - received with partnerID

pageRef - received with partnerID

blockId - required block's id, taken from Block.getId()

Throws:

java.lang.IllegalArgumentException - If the blocksInfo is null If the blockId is null If the targetRef is null If the pageRef is null

java.lang.NullPointerException - If the context is null

Method Detail

setPlayerSize

public VideoAdRequest.Builder setPlayerSize(int width,
                                            int height)

Sets preferable video size in pixels

Parameters:

width - width in pixels

height - height in pixels

Returns:

the same VideoAdRequest.Builder object.

setContentId

public VideoAdRequest.Builder setContentId(java.lang.String contentId)

Parameters:

contentId - - content identifier from administration panel

Returns:

the same VideoAdRequest.Builder object.

setContentName

public VideoAdRequest.Builder setContentName(java.lang.String contentName)

Parameters:

contentName - content title

Returns:

the same VideoAdRequest.Builder object.

setPublisherId

public VideoAdRequest.Builder setPublisherId(@Nullable
                                             java.lang.String publisherId)

Parameters:

publisherId - content owner's identifier

Returns:

the same VideoAdRequest.Builder object.

setPublisherName

public VideoAdRequest.Builder setPublisherName(@Nullable
                                               java.lang.String publisherName)

Parameters:

publisherName - content owner title

Returns:

the same VideoAdRequest.Builder object.

setMaxBitrate

public VideoAdRequest.Builder setMaxBitrate(int maxBitrate)

Parameters:

maxBitrate - maximum possible bitrate

Returns:

the same VideoAdRequest.Builder object.

setExtendedParams

public VideoAdRequest.Builder setExtendedParams(java.lang.String extendedParams)

Parameters:

extendedParams - some additional parameters

Returns:

the same VideoAdRequest.Builder object.

setCharset

public VideoAdRequest.Builder setCharset(@Nullable
                                         VideoAdRequest.Charset charset)

Parameters:

charset - One of the following predefined charsets should be used: UTF_8, CP_1251, KOI_8R, KOI_8U. VideoAdRequest.Charset class. Default is UTF-8 charset.

Returns:

the same VideoAdRequest.Builder object.

setGenreIds

public VideoAdRequest.Builder setGenreIds(@Nullable
                                          java.util.List<java.lang.String> genreIds)

Parameters:

genreIds - Genre ids, retrieved from advertising space.

Returns:

the same VideoAdRequest.Builder object.

setGenreNames

public VideoAdRequest.Builder setGenreNames(@Nullable
                                            java.util.List<java.lang.String> genreNames)

Parameters:

genreNames - Genre names, retrieved from advertising space.

Returns:

the same VideoAdRequest.Builder object.

setTagsList

public VideoAdRequest.Builder setTagsList(@Nullable
                                          java.util.List<java.lang.String> tagsList)

Parameters:

tagsList - Tag list, retrieved from advertising space.

Returns:

the same VideoAdRequest.Builder object.

build

public VideoAdRequest build()

Creates a VideoAdRequest with the arguments supplied to this builder. It does not perform that request.

Returns:

VideoAdRequest