Represents an AdBreak.
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.IAdBreak);Constructs a new AdBreak.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAdBreak
Properties to set |
Properties
adBreakId
public adBreakId?: (string|null);AdBreak adBreakId.
assetKey
public assetKey?: (string|null);AdBreak assetKey.
breakSequence
public breakSequence?: (number|Long|string|null);AdBreak breakSequence.
breakState
public breakState?: (google.ads.admanager.v1.AdBreakStateEnum.AdBreakState|keyof typeof google.ads.admanager.v1.AdBreakStateEnum.AdBreakState|null);AdBreak breakState.
customAssetKey
public customAssetKey?: (string|null);AdBreak customAssetKey.
customParams
public customParams?: (string|null);AdBreak customParams.
duration
public duration?: (google.protobuf.IDuration|null);AdBreak duration.
expectedStartTime
public expectedStartTime?: (google.protobuf.ITimestamp|null);AdBreak expectedStartTime.
name
public name: string;AdBreak name.
podTemplateName
public podTemplateName?: (string|null);AdBreak podTemplateName.
scte_35CueOut
public scte_35CueOut?: (string|null);AdBreak scte_35CueOut.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.IAdBreak): google.ads.admanager.v1.AdBreak;Creates a new AdBreak instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAdBreak
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
AdBreak instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AdBreak;Decodes an AdBreak 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 |
AdBreak |
AdBreak |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AdBreak;Decodes an AdBreak message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AdBreak |
AdBreak |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.IAdBreak, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AdBreak message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAdBreak
AdBreak 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.IAdBreak, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AdBreak message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAdBreak
AdBreak 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.AdBreak;Creates an AdBreak 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 |
AdBreak |
AdBreak |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AdBreak
| 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 AdBreak to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.AdBreak, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AdBreak message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AdBreak
AdBreak |
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 an AdBreak message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|