Show / Hide Table of Contents

Class AdSpot

An AdSpot is a targetable entity used in the creation of AdRule objects. A ad spot contains a variable number of ads and has constraints (ad duration, reservation type, etc) on the ads that can appear in it.

Inheritance
object
AdSpot
Implements
IMessage<AdSpot>
IEquatable<AdSpot>
IDeepCloneable<AdSpot>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class AdSpot : IMessage<AdSpot>, IEquatable<AdSpot>, IDeepCloneable<AdSpot>, IBufferMessage, IMessage

Constructors

AdSpot()

Declaration
public AdSpot()

AdSpot(AdSpot)

Declaration
public AdSpot(AdSpot other)
Parameters
Type Name Description
AdSpot other

Properties

AdSpotName

AdSpotName-typed view over the Name resource name property.

Declaration
public AdSpotName AdSpotName { get; set; }
Property Value
Type Description
AdSpotName

AllowedLineItemTypes

Optional. The set of line item types that may appear in the ad spot. This field is optional and defaults to an empty set, which means that all types are allowed. Note, backfill reservation types are controlled by the backfillBlocked field.

Declaration
public RepeatedField<LineItemTypeEnum.Types.LineItemType> AllowedLineItemTypes { get; }
Property Value
Type Description
RepeatedField<LineItemTypeEnum.Types.LineItemType>

BackfillBlocked

Optional. Whether backfill is blocked in this ad spot. This field is optional and defaults to false.

Declaration
public bool BackfillBlocked { get; set; }
Property Value
Type Description
bool

CanonicalDisplayName

Optional. Name of the AdSpot. The name is case insensitive and can be referenced in ad tags. This value is required if customSpot is true, and cannot be set otherwise. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.

Declaration
public string CanonicalDisplayName { get; set; }
Property Value
Type Description
string

CustomSpot

Optional. Whether this ad spot is a custom spot. This field is optional and defaults to false. Custom spots can be reused and targeted in the targeting picker.

Declaration
public bool CustomSpot { get; set; }
Property Value
Type Description
bool

DisplayName

Optional. Descriptive name for the AdSpot.This value is optional if customSpot is true, and cannot be set otherwise.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

Flexible

Optional. Whether this ad spot is a flexible spot. This field is optional and defaults to false. Flexible spots are allowed to have no max number of ads.

Declaration
public bool Flexible { get; set; }
Property Value
Type Description
bool

HasBackfillBlocked

Gets whether the "backfill_blocked" field is set

Declaration
public bool HasBackfillBlocked { get; }
Property Value
Type Description
bool

HasCanonicalDisplayName

Gets whether the "canonical_display_name" field is set

Declaration
public bool HasCanonicalDisplayName { get; }
Property Value
Type Description
bool

HasCustomSpot

Gets whether the "custom_spot" field is set

Declaration
public bool HasCustomSpot { get; }
Property Value
Type Description
bool

HasDisplayName

Gets whether the "display_name" field is set

Declaration
public bool HasDisplayName { get; }
Property Value
Type Description
bool

HasFlexible

Gets whether the "flexible" field is set

Declaration
public bool HasFlexible { get; }
Property Value
Type Description
bool

HasInventorySharingBlocked

Gets whether the "inventory_sharing_blocked" field is set

Declaration
public bool HasInventorySharingBlocked { get; }
Property Value
Type Description
bool

HasMaxAds

Gets whether the "max_ads" field is set

Declaration
public bool HasMaxAds { get; }
Property Value
Type Description
bool

HasTargetingType

Gets whether the "targeting_type" field is set

Declaration
public bool HasTargetingType { get; }
Property Value
Type Description
bool

InventorySharingBlocked

Optional. Whether inventory sharing is blocked in this ad spot. This field is optional and defaults to false.

Declaration
public bool InventorySharingBlocked { get; set; }
Property Value
Type Description
bool

MaxAdDuration

Required. The maximum allowed duration for ads in the AdSpot. This field is required and must be greater than [min_ad_duration][google.ads.admanager.v1.AdSpot.min_ad_duration].

Declaration
public Duration MaxAdDuration { get; set; }
Property Value
Type Description
Duration

MaxAds

Optional. The maximum number of ads allowed in the AdSpot. This field is optional and defaults to 0. A value of 0 means that there is no maximum for the number of ads in the ad spot. No max ads is only supported for ad spots that have flexible set to true.

Declaration
public int MaxAds { get; set; }
Property Value
Type Description
int

MaxDuration

Optional. The maximum total duration for this AdSpot. This field is optional, defaults to 0, and supports precision to the nearest second.

Declaration
public Duration MaxDuration { get; set; }
Property Value
Type Description
Duration

MinAdDuration

Optional. The minimum allowed duration for ads in the AdSpot. This field is optional and defaults to 0.

Declaration
public Duration MinAdDuration { get; set; }
Property Value
Type Description
Duration

Name

Identifier. The resource name of the AdSpot. Format: networks/{network_code}/adSpots/{ad_spot_id}

Declaration
public string Name { get; set; }
Property Value
Type Description
string

TargetingType

Optional. The AdSpot TargetingType determines how this ad spot can be targeted. This field is required.

Declaration
public AdSpotTargetingTypeEnum.Types.AdSpotTargetingType TargetingType { get; set; }
Property Value
Type Description
AdSpotTargetingTypeEnum.Types.AdSpotTargetingType
In this article
Back to top Generated by DocFX