Placement

import type { Placement } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Contains properties of a placement.

interface Placement {

accountId?: bigint;

activeStatus?:

| "PLACEMENT_STATUS_UNKNOWN"

| "PLACEMENT_STATUS_ACTIVE"

| "PLACEMENT_STATUS_INACTIVE"

| "PLACEMENT_STATUS_ARCHIVED"

| "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED";

adBlockingOptOut?: boolean;

additionalSizes?: Size[];

advertiserId?: bigint;

advertiserIdDimensionValue?: DimensionValue;

campaignId?: bigint;

campaignIdDimensionValue?: DimensionValue;

comment?: string;

compatibility?:

| "DISPLAY"

| "DISPLAY_INTERSTITIAL"

| "APP"

| "APP_INTERSTITIAL"

| "IN_STREAM_VIDEO"

| "IN_STREAM_AUDIO";

contentCategoryId?: bigint;

conversionDomainOverride?: PlacementConversionDomainOverride;

createInfo?: LastModifiedInfo;

directorySiteId?: bigint;

directorySiteIdDimensionValue?: DimensionValue;

externalId?: string;

id?: bigint;

idDimensionValue?: DimensionValue;

keyName?: string;

kind?: string;

lastModifiedInfo?: LastModifiedInfo;

lookbackConfiguration?: LookbackConfiguration;

name?: string;

partnerWrappingData?: MeasurementPartnerWrappingData;

paymentApproved?: boolean;

paymentSource?: "PLACEMENT_AGENCY_PAID" | "PLACEMENT_PUBLISHER_PAID";

placementGroupId?: bigint;

placementGroupIdDimensionValue?: DimensionValue;

placementStrategyId?: bigint;

pricingSchedule?: PricingSchedule;

primary?: boolean;

publisherUpdateInfo?: LastModifiedInfo;

siteId?: bigint;

siteIdDimensionValue?: DimensionValue;

size?: Size;

sslRequired?: boolean;

status?:

| "PENDING_REVIEW"

| "PAYMENT_ACCEPTED"

| "PAYMENT_REJECTED"

| "ACKNOWLEDGE_REJECTION"

| "ACKNOWLEDGE_ACCEPTANCE"

| "DRAFT";

subaccountId?: bigint;

tagFormats?:

| "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_TRACKING"

| "PLACEMENT_TAG_TRACKING_IFRAME"

| "PLACEMENT_TAG_TRACKING_JAVASCRIPT"

| "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"

| "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"

| "PLACEMENT_TAG_JAVASCRIPT_LEGACY"

| "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"

| "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"

| "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"

| "PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT"[];

tagSetting?: TagSetting;

videoActiveViewOptOut?: boolean;

videoSettings?: VideoSettings;

vpaidAdapterChoice?:

| "DEFAULT"

| "FLASH"

| "HTML5"

| "BOTH";

wrappingOptOut?: boolean;

}

§Properties

accountId?: bigint

[src]

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

activeStatus?: "PLACEMENT_STATUS_UNKNOWN" | "PLACEMENT_STATUS_ACTIVE" | "PLACEMENT_STATUS_INACTIVE" | "PLACEMENT_STATUS_ARCHIVED" | "PLACEMENT_STATUS_PERMANENTLY_ARCHIVED"

[src]

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

adBlockingOptOut?: boolean

[src]

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.

additionalSizes?: Size[]

[src]

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

advertiserId?: bigint

[src]

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

advertiserIdDimensionValue?: DimensionValue

[src]

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

campaignId?: bigint

[src]

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

campaignIdDimensionValue?: DimensionValue

[src]

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

comment?: string

[src]

Comments for this placement.

[src]

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.

contentCategoryId?: bigint

[src]

ID of the content category assigned to this placement.

conversionDomainOverride?: PlacementConversionDomainOverride

[src]

Optional. Conversion domain overrides for a placement.

createInfo?: LastModifiedInfo

[src]

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

directorySiteId?: bigint

[src]

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.

directorySiteIdDimensionValue?: DimensionValue

[src]

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

externalId?: string

[src]

External ID for this placement.

id?: bigint

[src]

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

idDimensionValue?: DimensionValue

[src]

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

keyName?: string

[src]

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

kind?: string

[src]

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

lastModifiedInfo?: LastModifiedInfo

[src]

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

lookbackConfiguration?: LookbackConfiguration

[src]

Lookback window settings for this placement.

name?: string

[src]

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

partnerWrappingData?: MeasurementPartnerWrappingData

[src]

Measurement partner provided settings for a wrapped placement.

paymentApproved?: boolean

[src]

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

paymentSource?: "PLACEMENT_AGENCY_PAID" | "PLACEMENT_PUBLISHER_PAID"

[src]

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

placementGroupId?: bigint

[src]

ID of this placement's group, if applicable.

placementGroupIdDimensionValue?: DimensionValue

[src]

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

placementStrategyId?: bigint

[src]

ID of the placement strategy assigned to this placement.

pricingSchedule?: PricingSchedule

[src]

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

primary?: boolean

[src]

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.

publisherUpdateInfo?: LastModifiedInfo

[src]

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

siteId?: bigint

[src]

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.

siteIdDimensionValue?: DimensionValue

[src]

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

size?: Size

[src]

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

sslRequired?: boolean

[src]

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

[src]

Third-party placement status.

subaccountId?: bigint

[src]

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

[src]

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"

tagSetting?: TagSetting

[src]

Tag settings for this placement.

videoActiveViewOptOut?: boolean

[src]

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.

videoSettings?: VideoSettings

[src]

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

vpaidAdapterChoice?: "DEFAULT" | "FLASH" | "HTML5" | "BOTH"

[src]

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.

wrappingOptOut?: boolean

[src]

Whether this placement opts out of tag wrapping.