REST Resource: networks.adSpots

Resource: 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.

JSON representation 
{
  "name": string,
  "allowedLineItemTypes": [
    enum (LineItemType)
  ],
  "canonicalDisplayName": string,
  "displayName": string,
  "customSpot": boolean,
  "flexible": boolean,
  "maxDuration": string,
  "minAdDuration": string,
  "maxAdDuration": string,
  "maxAds": integer,
  "targetingType": enum (AdSpotTargetingType),
  "backfillBlocked": boolean,
  "inventorySharingBlocked": boolean
}
Fields
name

string

Identifier. The resource name of the AdSpot. Format: networks/{networkCode}/adSpots/{ad_spot_id}
allowedLineItemTypes[]

enum (LineItemType)

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.
canonicalDisplayName

string

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.
displayName

string

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

boolean

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.
flexible

boolean

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.
maxDuration

string (Duration format)

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

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
minAdDuration

string (Duration format)

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

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
maxAdDuration

string (Duration format)

Required. The maximum allowed duration for ads in the AdSpot. This field is required and must be greater than minAdDuration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
maxAds

integer

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.
targetingType

enum (AdSpotTargetingType)

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

boolean

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

boolean

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

AdSpotTargetingType

Defines the targeting behavior of an ad spot.

Enums
AD_SPOT_TARGETING_TYPE_UNSPECIFIED Default value. This value is unused.
EXPLICITLY_TARGETED Only line items targeting this ad spots explicitly may serve in it
EXPLICITLY_TARGETED_EXCEPT_HOUSE If house ads are an allowed reservation type, they may serve in the ad spot regardless of whether they explicitly target it. Ads of other reservation types (whose type is allowed in the ad spot), may serve in the ad spot only if explicitly targeted.
NOT_REQUIRED Line items not targeting this ad spot explicitly may serve in it.

Methods

batchCreate

 API to batch create AdSpot objects.

batchUpdate

 API to batch update AdSpot objects.

create

 API to create an AdSpot object.

get

 API to retrieve an AdSpot object.

list

 API to retrieve a list of AdSpot objects.

patch

 API to update an AdSpot object.