Class Placement

Contains properties of a placement.

Inheritance

object

Placement

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dfareporting.v4.Data

Assembly: Google.Apis.Dfareporting.v4.dll

Syntax

public class Placement : IDirectResponseSchema

Properties

AccountId

Account ID of this placement. This field can be left blank.

Declaration

[JsonProperty("accountId")]
public virtual long? AccountId { get; set; }

Property Value

Type	Description
long?

ActiveStatus

Whether this placement is active, inactive, archived or permanently archived.

Declaration

[JsonProperty("activeStatus")]
public virtual string ActiveStatus { get; set; }

Property Value

Type	Description
string

AdBlockingOptOut

Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.

Declaration

[JsonProperty("adBlockingOptOut")]
public virtual bool? AdBlockingOptOut { get; set; }

Property Value

Type	Description
bool?

AdServingPlatformId

Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * 1, Adelphic * 2, Adform * 3, Adobe * 4, Amobee * 5, Basis (Centro) * 6, Beeswax * 7, Amazon * 8, DV360 (DBM) * 9, Innovid * 10, MediaMath * 11, Roku OneView DSP * 12, TabMo Hawk * 13, The Trade Desk * 14, Xandr Invest DSP * 15, Yahoo DSP * 16, Zeta Global * 17, Scaleout * 18, Bidtellect * 19, Unicorn * 20, Teads * 21, Quantcast * 22, Cognitiv

Declaration

[JsonProperty("adServingPlatformId")]
public virtual long? AdServingPlatformId { get; set; }

Property Value

Type	Description
long?

AdditionalSizes

Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.

Declaration

[JsonProperty("additionalSizes")]
public virtual IList<Size> AdditionalSizes { get; set; }

Property Value

Type	Description
IList<Size>

AdvertiserId

Advertiser ID of this placement. This field can be left blank.

Declaration

[JsonProperty("advertiserId")]
public virtual long? AdvertiserId { get; set; }

Property Value

Type	Description
long?

AdvertiserIdDimensionValue

Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.

Declaration

[JsonProperty("advertiserIdDimensionValue")]
public virtual DimensionValue AdvertiserIdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

CampaignId

Campaign ID of this placement. This field is a required field on insertion.

Declaration

[JsonProperty("campaignId")]
public virtual long? CampaignId { get; set; }

Property Value

Type	Description
long?

CampaignIdDimensionValue

Dimension value for the ID of the campaign. This is a read-only, auto-generated field.

Declaration

[JsonProperty("campaignIdDimensionValue")]
public virtual DimensionValue CampaignIdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

Comment

Comments for this placement.

Declaration

[JsonProperty("comment")]
public virtual string Comment { get; set; }

Property Value

Type	Description
string

Compatibility

Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.

Declaration

[JsonProperty("compatibility")]
public virtual string Compatibility { get; set; }

Property Value

Type	Description
string

ContentCategoryId

ID of the content category assigned to this placement.

Declaration

[JsonProperty("contentCategoryId")]
public virtual long? ContentCategoryId { get; set; }

Property Value

Type	Description
long?

ConversionDomainOverride

Optional. Conversion domain overrides for a placement.

Declaration

[JsonProperty("conversionDomainOverride")]
public virtual PlacementConversionDomainOverride ConversionDomainOverride { get; set; }

Property Value

Type	Description
PlacementConversionDomainOverride

CreateInfo

Information about the creation of this placement. This is a read-only field.

Declaration

[JsonProperty("createInfo")]
public virtual LastModifiedInfo CreateInfo { get; set; }

Property Value

Type	Description
LastModifiedInfo

DirectorySiteId

Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.

Declaration

[JsonProperty("directorySiteId")]
public virtual long? DirectorySiteId { get; set; }

Property Value

Type	Description
long?

DirectorySiteIdDimensionValue

Dimension value for the ID of the directory site. This is a read-only, auto-generated field.

Declaration

[JsonProperty("directorySiteIdDimensionValue")]
public virtual DimensionValue DirectorySiteIdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExternalId

External ID for this placement.

Declaration

[JsonProperty("externalId")]
public virtual string ExternalId { get; set; }

Property Value

Type	Description
string

Id

ID of this placement. This is a read-only, auto-generated field.

Declaration

[JsonProperty("id")]
public virtual long? Id { get; set; }

Property Value

Type	Description
long?

IdDimensionValue

Dimension value for the ID of this placement. This is a read-only, auto-generated field.

Declaration

[JsonProperty("idDimensionValue")]
public virtual DimensionValue IdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

KeyName

Key name of this placement. This is a read-only, auto-generated field.

Declaration

[JsonProperty("keyName")]
public virtual string KeyName { get; set; }

Property Value

Type	Description
string

Kind

Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement".

Declaration

[JsonProperty("kind")]
public virtual string Kind { get; set; }

Property Value

Type	Description
string

LastModifiedInfo

Information about the most recent modification of this placement. This is a read-only field.

Declaration

[JsonProperty("lastModifiedInfo")]
public virtual LastModifiedInfo LastModifiedInfo { get; set; }

Property Value

Type	Description
LastModifiedInfo

LookbackConfiguration

Lookback window settings for this placement.

Declaration

[JsonProperty("lookbackConfiguration")]
public virtual LookbackConfiguration LookbackConfiguration { get; set; }

Property Value

Type	Description
LookbackConfiguration

Name

Name of this placement.This is a required field and must be less than or equal to 512 characters long.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

PartnerWrappingData

Measurement partner provided settings for a wrapped placement.

Declaration

[JsonProperty("partnerWrappingData")]
public virtual MeasurementPartnerWrappingData PartnerWrappingData { get; set; }

Property Value

Type	Description
MeasurementPartnerWrappingData

PaymentApproved

Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.

Declaration

[JsonProperty("paymentApproved")]
public virtual bool? PaymentApproved { get; set; }

Property Value

Type	Description
bool?

PaymentSource

Payment source for this placement. This is a required field that is read-only after insertion.

Declaration

[JsonProperty("paymentSource")]
public virtual string PaymentSource { get; set; }

Property Value

Type	Description
string

PlacementGroupId

ID of this placement's group, if applicable.

Declaration

[JsonProperty("placementGroupId")]
public virtual long? PlacementGroupId { get; set; }

Property Value

Type	Description
long?

PlacementGroupIdDimensionValue

Dimension value for the ID of the placement group. This is a read-only, auto-generated field.

Declaration

[JsonProperty("placementGroupIdDimensionValue")]
public virtual DimensionValue PlacementGroupIdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

PlacementStrategyId

ID of the placement strategy assigned to this placement.

Declaration

[JsonProperty("placementStrategyId")]
public virtual long? PlacementStrategyId { get; set; }

Property Value

Type	Description
long?

PricingSchedule

Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.

Declaration

[JsonProperty("pricingSchedule")]
public virtual PricingSchedule PricingSchedule { get; set; }

Property Value

Type	Description
PricingSchedule

Primary

Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement.

Declaration

[JsonProperty("primary")]
public virtual bool? Primary { get; set; }

Property Value

Type	Description
bool?

PublisherUpdateInfo

Information about the last publisher update. This is a read-only field.

Declaration

[JsonProperty("publisherUpdateInfo")]
public virtual LastModifiedInfo PublisherUpdateInfo { get; set; }

Property Value

Type	Description
LastModifiedInfo

SiteId

Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.

Declaration

[JsonProperty("siteId")]
public virtual long? SiteId { get; set; }

Property Value

Type	Description
long?

SiteIdDimensionValue

Dimension value for the ID of the site. This is a read-only, auto-generated field.

Declaration

[JsonProperty("siteIdDimensionValue")]
public virtual DimensionValue SiteIdDimensionValue { get; set; }

Property Value

Type	Description
DimensionValue

SiteServed

Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.

Declaration

[JsonProperty("siteServed")]
public virtual bool? SiteServed { get; set; }

Property Value

Type	Description
bool?

Size

Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.

Declaration

[JsonProperty("size")]
public virtual Size Size { get; set; }

Property Value

Type	Description
Size

SslRequired

Whether creatives assigned to this placement must be SSL-compliant.

Declaration

[JsonProperty("sslRequired")]
public virtual bool? SslRequired { get; set; }

Property Value

Type	Description
bool?

Status

Third-party placement status.

Declaration

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
string

SubaccountId

Subaccount ID of this placement. This field can be left blank.

Declaration

[JsonProperty("subaccountId")]
public virtual long? SubaccountId { get; set; }

Property Value

Type	Description
long?

TagFormats

Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_IFRAME_ILAYER" - "PLACEMENT_TAG_INTERNAL_REDIRECT" - "PLACEMENT_TAG_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - "PLACEMENT_TAG_CLICK_COMMANDS" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - "PLACEMENT_TAG_TRACKING" - "PLACEMENT_TAG_TRACKING_IFRAME"

• "PLACEMENT_TAG_TRACKING_JAVASCRIPT"

Declaration

[JsonProperty("tagFormats")]
public virtual IList<string> TagFormats { get; set; }

Property Value

Type	Description
IList<string>

TagSetting

Tag settings for this placement.

Declaration

[JsonProperty("tagSetting")]
public virtual TagSetting TagSetting { get; set; }

Property Value

Type	Description
TagSetting

VideoActiveViewOptOut

Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.

Declaration

[JsonProperty("videoActiveViewOptOut")]
public virtual bool? VideoActiveViewOptOut { get; set; }

Property Value

Type	Description
bool?

VideoSettings

A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.

Declaration

[JsonProperty("videoSettings")]
public virtual VideoSettings VideoSettings { get; set; }

Property Value

Type	Description
VideoSettings

VpaidAdapterChoice

VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.

Declaration

[JsonProperty("vpaidAdapterChoice")]
public virtual string VpaidAdapterChoice { get; set; }

Property Value

Type	Description
string

WrappingOptOut

Whether this placement opts out of tag wrapping.

Declaration

[JsonProperty("wrappingOptOut")]
public virtual bool? WrappingOptOut { get; set; }

Property Value

Type	Description
bool?

Implements

IDirectResponseSchema