Represents an AdSpot.
Implements
Package
@google-ads/admanagerConstructors
(constructor)(properties)
constructor(properties?: google.ads.admanager.v1.IAdSpot);Constructs a new AdSpot.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAdSpot
Properties to set |
Properties
allowedLineItemTypes
public allowedLineItemTypes: google.ads.admanager.v1.LineItemTypeEnum.LineItemType[];AdSpot allowedLineItemTypes.
backfillBlocked
public backfillBlocked?: (boolean|null);AdSpot backfillBlocked.
canonicalDisplayName
public canonicalDisplayName?: (string|null);AdSpot canonicalDisplayName.
customSpot
public customSpot?: (boolean|null);AdSpot customSpot.
displayName
public displayName?: (string|null);AdSpot displayName.
flexible
public flexible?: (boolean|null);AdSpot flexible.
inventorySharingBlocked
public inventorySharingBlocked?: (boolean|null);AdSpot inventorySharingBlocked.
maxAdDuration
public maxAdDuration?: (google.protobuf.IDuration|null);AdSpot maxAdDuration.
maxAds
public maxAds?: (number|null);AdSpot maxAds.
maxDuration
public maxDuration?: (google.protobuf.IDuration|null);AdSpot maxDuration.
minAdDuration
public minAdDuration?: (google.protobuf.IDuration|null);AdSpot minAdDuration.
name
public name: string;AdSpot name.
targetingType
public targetingType?: (google.ads.admanager.v1.AdSpotTargetingTypeEnum.AdSpotTargetingType|keyof typeof google.ads.admanager.v1.AdSpotTargetingTypeEnum.AdSpotTargetingType|null);AdSpot targetingType.
Methods
create(properties)
public static create(properties?: google.ads.admanager.v1.IAdSpot): google.ads.admanager.v1.AdSpot;Creates a new AdSpot instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAdSpot
Properties to set |
| Returns | |
|---|---|
| Type | Description |
AdSpot |
AdSpot instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.admanager.v1.AdSpot;Decodes an AdSpot 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 |
AdSpot |
AdSpot |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.admanager.v1.AdSpot;Decodes an AdSpot message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
AdSpot |
AdSpot |
encode(message, writer)
public static encode(message: google.ads.admanager.v1.IAdSpot, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AdSpot message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAdSpot
AdSpot 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.IAdSpot, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified AdSpot message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAdSpot
AdSpot 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.AdSpot;Creates an AdSpot 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 |
AdSpot |
AdSpot |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for AdSpot
| 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 AdSpot to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.ads.admanager.v1.AdSpot, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an AdSpot message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
AdSpot
AdSpot |
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 AdSpot message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|