Represents a LiveStream.
Implements
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.ILiveStream);Constructs a new LiveStream.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILiveStream
Properties to set |
Properties
adBreakFillType
public adBreakFillType?: (google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType|keyof typeof google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType|null);LiveStream adBreakFillType.
adBreakMarkups
public adBreakMarkups: google.ads.admanager.v1.AdBreakMarkupTypeEnum.AdBreakMarkupType[];LiveStream adBreakMarkups.
adBreakMarkupTypesEnabled
public adBreakMarkupTypesEnabled?: (boolean|null);LiveStream adBreakMarkupTypesEnabled.
adHolidayDuration
public adHolidayDuration?: (google.protobuf.IDuration|null);LiveStream adHolidayDuration.
adMediaDeliveryConfig
public adMediaDeliveryConfig?: (string|null);LiveStream adMediaDeliveryConfig.
adPodTrimTolerance
public adPodTrimTolerance?: (google.protobuf.IDuration|null);LiveStream adPodTrimTolerance.
adTags
public adTags: string[];LiveStream adTags.
allowlistedIpsEnabled
public allowlistedIpsEnabled?: (boolean|null);LiveStream allowlistedIpsEnabled.
assetKey
public assetKey?: (string|null);LiveStream assetKey.
auxiliaryAdSettings
public auxiliaryAdSettings?: (google.ads.admanager.v1.IAuxiliaryAdSettings|null);LiveStream auxiliaryAdSettings.
contentUrls
public contentUrls: string[];LiveStream contentUrls.
createTime
public createTime?: (google.protobuf.ITimestamp|null);LiveStream createTime.
customAssetKey
public customAssetKey?: (string|null);LiveStream customAssetKey.
defaultAdBreakDuration
public defaultAdBreakDuration?: (google.protobuf.IDuration|null);LiveStream defaultAdBreakDuration.
displayName
public displayName?: (string|null);LiveStream displayName.
dynamicAdInsertionType
public dynamicAdInsertionType?: (google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType|keyof typeof google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType|null);LiveStream dynamicAdInsertionType.
earlyBreakNotificationMultiBreakSchedulingEnabled
public earlyBreakNotificationMultiBreakSchedulingEnabled?: (boolean|null);LiveStream earlyBreakNotificationMultiBreakSchedulingEnabled.
effectiveAssetKey
public effectiveAssetKey?: (string|null);LiveStream effectiveAssetKey.
enableDaiAuthenticationKeys
public enableDaiAuthenticationKeys?: (boolean|null);LiveStream enableDaiAuthenticationKeys.
enableDurationlessAdBreaks
public enableDurationlessAdBreaks?: (boolean|null);LiveStream enableDurationlessAdBreaks.
enableMaxFillerDuration
public enableMaxFillerDuration?: (boolean|null);LiveStream enableMaxFillerDuration.
endTime
public endTime?: (google.protobuf.ITimestamp|null);LiveStream endTime.
endTimeUnlimited
public endTimeUnlimited?: (boolean|null);LiveStream endTimeUnlimited.
forcedCueInEnabled
public forcedCueInEnabled?: (boolean|null);LiveStream forcedCueInEnabled.
hlsSettings
public hlsSettings?: (google.ads.admanager.v1.IHlsSettings|null);LiveStream hlsSettings.
liveStreamConditioning
public liveStreamConditioning?: (google.ads.admanager.v1.ILiveStreamConditioning|null);LiveStream liveStreamConditioning.
maxFillerDuration
public maxFillerDuration?: (google.protobuf.IDuration|null);LiveStream maxFillerDuration.
name
public name: string;LiveStream name.
podServingSegmentDuration
public podServingSegmentDuration?: (google.protobuf.IDuration|null);LiveStream podServingSegmentDuration.
prefetchEnabled
public prefetchEnabled?: (boolean|null);LiveStream prefetchEnabled.
prefetchSettings
public prefetchSettings?: (google.ads.admanager.v1.IPrefetchSettings|null);LiveStream prefetchSettings.
prerollSettings
public prerollSettings?: (google.ads.admanager.v1.IPrerollSettings|null);LiveStream prerollSettings.
relativePlaylistDeliveryEnabled
public relativePlaylistDeliveryEnabled?: (boolean|null);LiveStream relativePlaylistDeliveryEnabled.
shortSegmentDroppingEnabled
public shortSegmentDroppingEnabled?: (boolean|null);LiveStream shortSegmentDroppingEnabled.
sourceContentConfigurations
public sourceContentConfigurations: string[];LiveStream sourceContentConfigurations.
startTime
public startTime?: (google.protobuf.ITimestamp|null);LiveStream startTime.
status
public status?: (google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus|keyof typeof google.ads.admanager.v1.LiveStreamEventStatusEnum.LiveStreamEventStatus|null);LiveStream status.
streamingFormat
public streamingFormat?: (google.ads.admanager.v1.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat|keyof typeof google.ads.admanager.v1.LiveStreamEventStreamingFormatEnum.LiveStreamEventStreamingFormat|null);LiveStream streamingFormat.
underfillAdBreakFillType
public underfillAdBreakFillType?: (google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType|keyof typeof google.ads.admanager.v1.AdBreakFillTypeEnum.AdBreakFillType|null);LiveStream underfillAdBreakFillType.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);LiveStream updateTime.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.ILiveStream): google.ads.admanager.v1.LiveStream;Creates a new LiveStream instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILiveStream
Properties to set |
| Returns | |
|---|---|
| Type | Description |
LiveStream |
LiveStream instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.LiveStream;Decodes a LiveStream message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
LiveStream |
LiveStream |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.LiveStream;Decodes a LiveStream message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
LiveStream |
LiveStream |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.ILiveStream, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LiveStream message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILiveStream
LiveStream message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.ads.admanager.v1.ILiveStream, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LiveStream message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILiveStream
LiveStream message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.ads.admanager.v1.LiveStream;Creates a LiveStream message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
LiveStream |
LiveStream |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for LiveStream
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this LiveStream to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.LiveStream, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a LiveStream message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
LiveStream
LiveStream |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a LiveStream message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|