类：广告

google.ima.广告

class   static

由代表不同广告类型的类扩展的广告类。

方法

getAdId

getAdId() 返回字符串

广告 ID 用于同步主广告和随播广告。

返回

string：广告的 ID，如果未提供此信息，则为空字符串。

获取 AdPodInfo

getAdPodInfo() 会返回 AdPodInfo

返回广告的广告连播信息。

返回

non-null AdPodInfo 广告的广告连播信息。

getAdSystem

getAdSystem() 返回字符串

广告响应中包含的源广告服务器信息。

返回

string：广告的源广告服务器；如果没有相关信息，则为空字符串。

getAdvertiserName

getAdvertiserName() 返回字符串

投放方定义的广告客户名称。

返回

string：广告客户名称，如果此信息不可用，则为空字符串。

getApiFramework

getApiFramework() 返回字符串

标识执行广告所需的 API。这与 vast 中指定的 apiFramework 相对应。

返回

nullable string：API 框架需要执行广告，如果此信息不可用，则为 null。

getCompanionAds

getCompanionAds(adSlotWidth, adSlotHeight, settings) 会返回非 null CompanionAd 数组

根据随播广告位尺寸获取该广告的随播广告。 可以选择接受高级选择设置。 请注意，此方法仅会针对在 STARTED 事件期间或之后获取的广告实例返回非空数组。具体而言，来自 LOADED 事件的广告将返回空数组。

参数
adSlotWidth	number 随播广告位的宽度。
adSlotHeight	number 随播广告位的高度。
设置	选填 CompanionAdSelectionSettings 随播广告的选择设置。 值不能为 null。

返回

non-null Array of non-null CompanionAd：与设置和广告位尺寸匹配的随播广告数组。

getContentType

getContentType() 返回字符串

返回当前所选广告素材的内容类型。如果未选择广告素材或内容类型不可用，则返回空字符串。对于线性广告，内容类型仅在选择媒体文件后才在 START 事件发生后可用。

返回

string：内容类型，如果不可用，则为空字符串。

getCreativeAdId

getCreativeAdId() 返回字符串

返回广告的 ISCI（行业标准商业广告标识符）代码；如果代码不可用，则返回空字符串。这是 VAST 响应中广告素材的广告 ID。

返回

string 

getCreativeId

getCreativeId() 返回字符串

检索广告的选定广告素材的 ID。

返回

string 广告的选定广告素材的 ID；如果此信息不可用，则为空字符串。

getDealId

getDealId() 返回字符串

返回当前广告的封装容器链中存在的第一个交易 ID（从顶部开始）。如果不可用，则返回空字符串。

返回

string 

getDescription

getDescription() 返回字符串

从 VAST 响应中返回此广告的描述。

返回

string 说明。如果未指定，则为空。

getDuration

getDuration() 返回数字

返回所选广告素材的时长，或者返回非线性广告素材的值 -1。

返回

number：所选广告素材的时长（以秒为单位），如果是非线性广告，则为 -1。

getHeight

getHeight() 返回数字

返回所选非线性广告素材的高度。

返回

number：所选非线性广告素材的高度，线性广告素材的价格为 0。

getMediaUrl

getMediaUrl() 返回字符串

根据当前正在使用的媒体选择设置，返回从广告中选择的媒体文件的网址。如果此信息不可用，则返回 null。可用于 STARTED 事件。

返回

nullable string 

getMinSuggestedDuration

getMinSuggestedDuration() 会返回数字

返回非线性广告素材应展示的最短建议时长（以秒为单位）。如果建议的最短持续时间未知，则返回 -2。对于线性广告素材，它会返回广告的整个时长。

返回

number：广告素材应展示的最短建议时长（以秒为单位）。

getSkipTimeOffset

getSkipTimeOffset() 返回数字

在广告开始播放前可跳过的秒数。对于不可跳过式广告或无法返回此属性，系统会返回 -1。

返回

number：以秒为单位的偏移量，或 -1。

getSurveyUrl

getSurveyUrl() 返回字符串

返回与指定广告的调查问卷关联的网址。如果不可用，则返回 null。

返回

nullable string 

getTitle

getTitle() 返回字符串

从 VAST 响应中返回此广告的标题。

返回

string 标题，如果未指定，则为空。

gettraffickingParameters

get TraffickingParameters() 返回具有字符串属性的对象

获取在投放广告时与广告相关联的自定义参数。

返回

non-null Object with string properties：将广告投放管理键与其值对应的映射；如果没有这些信息，则为空对象。

gettraffickingParametersString

gettraffickingParametersString() 返回字符串

获取在投放广告时与广告相关联的自定义参数。从 gettraffickingParameters 返回解析后的参数的原始字符串版本。

返回

string：广告投放管理参数；如果未提供此信息，则为空字符串。

getUiElement

getUiElement() 返回字符串数组

返回播放此广告时显示的界面元素。 如需了解返回的数组的可能元素，请参阅 UiElements。

返回

non-null Array of string：正在显示的界面元素。

getUniversalAdIdRegistry

getUniversalAdIdRegistry() 返回字符串

为广告选择的所选广告素材的 UniversalAdId 关联的注册表。

已弃用

改用 ad.getUniversalAdIds()

返回

string 返回注册表值；如果不可用，则返回“unknown”。

getUniversalAdIdValue

getUniversalAdIdValue() 返回字符串

广告的所选广告素材的 UniversalAdId。

已弃用

改用 ad.getUniversalAdIds()

返回

string 返回 ID 值或“未知”（如果不可用）。

getUniversalAdIds

getUniversalAdIds() 返回非 null UniversalAdIdInfo 数组

为广告选择的广告素材的 UniversalAdId 列表。

返回

non-null Array of non-null UniversalAdIdInfo 返回适用于该广告的通用广告 ID 信息列表。

getVastMediaBitrate

getVastMediaBitrate() 返回数字

如果 SDK 选择了广告素材和媒体文件，此操作会返回 VAST 响应中列出的媒体文件的比特率。

返回

number：所选媒体文件的比特率或设为 0。

getVastMediaHeight

getVastMediaHeight() 返回数字

返回所选广告素材的 VAST 媒体高度。

返回

number：所选广告素材的 VAST 媒体高度，如果未选择，则为 0。

getVastMediaWidth

getVastMediaWidth() 返回数字

返回所选广告素材的 VAST 媒体宽度。

返回

number：所选广告素材的 VAST 媒体宽度，如果未选择，则为 0。

getWidth

getWidth() 返回数字

返回所选广告素材的宽度。

返回

number：所选非线性广告素材的宽度，或者对于线性广告素材，则为 0。

get 封装容器广告 ID

get 封装容器 AdIds() 返回字符串数组

用于封装容器广告的广告 ID。返回的 ID 从内嵌广告（最内层）开始，然后遍历最外层的封装容器广告。如果没有封装容器广告，则返回空数组。

返回

non-null Array of string：广告的 ID，从内嵌广告开始；如果没有封装容器广告，则为空数组。

get 封装容器广告系统

get 封装容器 AdSystems() 返回字符串数组

用于封装容器广告的广告系统。返回的广告系统从内嵌广告开始，然后遍历最外层的封装容器广告。如果没有封装容器广告，则返回空数组。

返回

non-null Array of string：广告的广告系统，从内嵌广告开始；如果没有封装容器广告，则为空数组。

get 封装容器广告素材 ID

get 封装容器 CreativeIds() 返回字符串数组

用于封装容器广告的所选广告素材 ID。返回的广告素材 ID 从内嵌广告开始，然后遍历最外层的封装容器广告。如果没有封装容器广告，则返回空数组。

返回

non-null Array of string 广告素材的 ID（从内嵌广告开始），如果没有封装容器广告，则为空数组。

线性

isLinear() 返回布尔值

指明广告的当前操作模式是线性操作还是非线性操作。如果值为 true，则表示广告处于线性播放模式；如果为 false，则表示广告为非线性模式。播放器会检查线性属性并根据广告展示位置的详细信息更新其状态。当广告处于线性模式时，播放器会暂停内容视频。如果最初的线性为 true，且广告是前贴片广告（外部定义），播放器可以选择延迟加载内容视频，直到广告播放结束。

返回

boolean 如果广告是线性的，则为 true，否则为 false。