--- title: "POST /userprofiles/{userprofilesId}/placements" method: POST path: "/userprofiles/{userprofilesId}/placements" tags: ["placements"] --- # POST /userprofiles/{userprofilesId}/placements `POST /userprofiles/{userprofilesId}/placements` ## Request - Base URL: `https://dfareporting.googleapis.com/dfareporting/v5` - URL: `https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{userprofilesId}/placements` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/dfatrafficking` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/dfatrafficking` - TypeScript: (a function with typed inputs; its response is checked against the schema) Inserts a new placement. ## Path parameters - `userprofilesId` string, required ## Request body - Placement: Contains properties of a placement. - `accountId` string, int64: 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': Whether this placement is active, inactive, archived or permanently archived. - `adBlockingOptOut` boolean: 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. - `adServingPlatformId` string, int64: 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 * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint - `additionalSizes` Size[]: Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `advertiserId` string, int64: Advertiser ID of this placement. This field can be left blank. - `advertiserIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `allowOnYoutube` boolean: Optional. Whether the placement is enabled for YouTube integration. - `campaignId` string, int64: Campaign ID of this placement. This field is a required field on insertion. - `campaignIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `comment` string: Comments for this placement. - `compatibility` 'DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO': 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` string, int64: ID of the content category assigned to this placement. - `conversionDomainOverride` PlacementConversionDomainOverride - `conversionDomains` PlacementSingleConversionDomain[] - `conversionDomainId` string, int64 - `conversionDomainValue` string - `createInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `directorySiteId` string, int64: 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: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `externalId` string: External ID for this placement. - `id` string, int64: ID of this placement. This is a read-only, auto-generated field. - `idDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `keyName` string: Key name of this placement. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". - `lastModifiedInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `lookbackConfiguration` LookbackConfiguration: Lookback configuration settings. - `clickDuration` integer: Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - `postImpressionActivitiesDuration` integer: Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - `name` string: Name of this placement.This is a required field and must be less than or equal to 512 characters long. - `partnerWrappingData` MeasurementPartnerWrappingData: Placement tag wrapping - `linkStatus` 'MEASUREMENT_PARTNER_UNLINKED' | 'MEASUREMENT_PARTNER_LINKED' | 'MEASUREMENT_PARTNER_LINK_PENDING' | 'MEASUREMENT_PARTNER_LINK_FAILURE' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING' | 'MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING' | 'MEASUREMENT_PARTNER_MODE_CHANGE_PENDING' | 'MEASUREMENT_PARTNER_UNLINK_PENDING': Placement wrapping status. - `measurementPartner` 'NONE' | 'INTEGRAL_AD_SCIENCE' | 'DOUBLE_VERIFY': Measurement partner used for wrapping the placement. - `tagWrappingMode` 'NONE' | 'BLOCKING' | 'MONITORING' | 'MONITORING_READ_ONLY' | 'VIDEO_PIXEL_MONITORING' | 'TRACKING' | 'VPAID_MONITORING' | 'VPAID_BLOCKING' | 'NON_VPAID_MONITORING' | 'VPAID_ONLY_MONITORING' | 'VPAID_ONLY_BLOCKING' | 'VPAID_ONLY_FILTERING' | 'VPAID_FILTERING' | 'NON_VPAID_FILTERING' | 'BLOCKING_FILTERING_VPAID' | 'BLOCKING_FILTERING_VPAID_ONLY': Measurement mode for the wrapped placement. - `wrappedTag` string: Tag provided by the measurement partner during wrapping. - `paymentApproved` boolean: 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': Payment source for this placement. This is a required field that is read-only after insertion. - `placementGroupId` string, int64: ID of this placement's group, if applicable. - `placementGroupIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `placementStrategyId` string, int64: ID of the placement strategy assigned to this placement. - `pricingSchedule` PricingSchedule: Pricing Schedule - `capCostOption` 'CAP_COST_NONE' | 'CAP_COST_MONTHLY' | 'CAP_COST_CUMULATIVE': Placement cap cost option. - `endDate` string, date - `flighted` boolean: Whether this placement is flighted. If true, pricing periods will be computed automatically. - `floodlightActivityId` string, int64: Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. - `pricingPeriods` PricingSchedulePricingPeriod[]: Pricing periods for this placement. - `endDate` string, date - `pricingComment` string: Comments for this pricing period. - `rateOrCostNanos` string, int64: Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. - `startDate` string, date - `units` string, int64: Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. - `pricingType` 'PRICING_TYPE_CPM' | 'PRICING_TYPE_CPC' | 'PRICING_TYPE_CPA' | 'PRICING_TYPE_FLAT_RATE_IMPRESSIONS' | 'PRICING_TYPE_FLAT_RATE_CLICKS' | 'PRICING_TYPE_CPM_ACTIVEVIEW': Placement pricing type. This field is required on insertion. - `startDate` string, date - `testingStartDate` string, date - `primary` boolean: 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: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `siteId` string, int64: 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: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `siteServed` boolean: 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. - `size` Size: Represents the dimensions of ads, placements, creatives, or creative assets. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `sslRequired` boolean: Whether creatives assigned to this placement must be SSL-compliant. - `status` 'PENDING_REVIEW' | 'PAYMENT_ACCEPTED' | 'PAYMENT_REJECTED' | 'ACKNOWLEDGE_REJECTION' | 'ACKNOWLEDGE_ACCEPTANCE' | 'DRAFT': Third-party placement status. - `subaccountId` string, int64: Subaccount ID of this placement. This field can be left blank. - `tagFormats` string[]: 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: Tag Settings - `additionalKeyValues` string: Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. - `includeClickThroughUrls` boolean: Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. - `includeClickTracking` boolean: Whether click-tracking string should be included in the tags. - `includeUnescapedlpurlMacro` boolean: Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. - `keywordOption` 'PLACEHOLDER_WITH_LIST_OF_KEYWORDS' | 'IGNORE' | 'GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD': Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. - `videoActiveViewOptOut` boolean: 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: Video Settings - `companionSettings` CompanionSetting: Companion Settings - `companionsDisabled` boolean: Whether companions are disabled for this placement. - `enabledSizes` Size[]: Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `imageOnly` boolean: Whether to serve only static images as companions. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". - `durationSeconds` integer: Duration of a video placement in seconds. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". - `obaEnabled` boolean: Whether OBA icons are enabled for this placement. - `obaSettings` ObaIcon: Online Behavioral Advertiser icon. - `iconClickThroughUrl` string: URL to redirect to when an OBA icon is clicked. - `iconClickTrackingUrl` string: URL to track click when an OBA icon is clicked. - `iconViewTrackingUrl` string: URL to track view when an OBA icon is clicked. - `program` string: Identifies the industry initiative that the icon supports. For example, AdChoices. - `resourceUrl` string: OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more - `size` Size: Represents the dimensions of ads, placements, creatives, or creative assets. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `xPosition` string: OBA icon x coordinate position. Accepted values are left or right. - `yPosition` string: OBA icon y coordinate position. Accepted values are top or bottom. - `orientation` 'ANY' | 'LANDSCAPE' | 'PORTRAIT': Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - `publisherSpecificationId` string, int64: Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max - `skippableSettings` SkippableSetting: Skippable Settings - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". - `progressOffset` VideoOffset: Video Offset - `offsetPercentage` integer: Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - `offsetSeconds` integer: Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - `skipOffset` VideoOffset: Video Offset - `offsetPercentage` integer: Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - `offsetSeconds` integer: Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - `skippable` boolean: Whether the user can skip creatives served to this placement. - `transcodeSettings` TranscodeSetting: Transcode Settings - `enabledVideoFormats` integer[]: Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". - `vpaidAdapterChoice` 'DEFAULT' | 'FLASH' | 'HTML5' | 'BOTH': 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: Whether this placement opts out of tag wrapping. - `youtubeSettings` YoutubeSettings: Contains the YouTube settings. - `businessLogoCreativeIds` string[]: Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported. - `businessName` string: Optional. The business name. - `callToActions` string[]: Optional. The call to actions. Currently only one call to action is supported. - `descriptions` string[]: Optional. The descriptions. Currently only one description is supported. - `headlines` string[]: Optional. The headlines associated with the call to actions. Currently only one headline is supported. - `longHeadlines` string[]: Optional. The long headlines. Currently only one long headline is supported. ## Response `200` Successful response - Placement: Contains properties of a placement. - `accountId` string, int64: 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': Whether this placement is active, inactive, archived or permanently archived. - `adBlockingOptOut` boolean: 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. - `adServingPlatformId` string, int64: 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 * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint - `additionalSizes` Size[]: Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `advertiserId` string, int64: Advertiser ID of this placement. This field can be left blank. - `advertiserIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `allowOnYoutube` boolean: Optional. Whether the placement is enabled for YouTube integration. - `campaignId` string, int64: Campaign ID of this placement. This field is a required field on insertion. - `campaignIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `comment` string: Comments for this placement. - `compatibility` 'DISPLAY' | 'DISPLAY_INTERSTITIAL' | 'APP' | 'APP_INTERSTITIAL' | 'IN_STREAM_VIDEO' | 'IN_STREAM_AUDIO': 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` string, int64: ID of the content category assigned to this placement. - `conversionDomainOverride` PlacementConversionDomainOverride - `conversionDomains` PlacementSingleConversionDomain[] - `conversionDomainId` string, int64 - `conversionDomainValue` string - `createInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `directorySiteId` string, int64: 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: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `externalId` string: External ID for this placement. - `id` string, int64: ID of this placement. This is a read-only, auto-generated field. - `idDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `keyName` string: Key name of this placement. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#placement". - `lastModifiedInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `lookbackConfiguration` LookbackConfiguration: Lookback configuration settings. - `clickDuration` integer: Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - `postImpressionActivitiesDuration` integer: Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive. - `name` string: Name of this placement.This is a required field and must be less than or equal to 512 characters long. - `partnerWrappingData` MeasurementPartnerWrappingData: Placement tag wrapping - `linkStatus` 'MEASUREMENT_PARTNER_UNLINKED' | 'MEASUREMENT_PARTNER_LINKED' | 'MEASUREMENT_PARTNER_LINK_PENDING' | 'MEASUREMENT_PARTNER_LINK_FAILURE' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT' | 'MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING' | 'MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING' | 'MEASUREMENT_PARTNER_MODE_CHANGE_PENDING' | 'MEASUREMENT_PARTNER_UNLINK_PENDING': Placement wrapping status. - `measurementPartner` 'NONE' | 'INTEGRAL_AD_SCIENCE' | 'DOUBLE_VERIFY': Measurement partner used for wrapping the placement. - `tagWrappingMode` 'NONE' | 'BLOCKING' | 'MONITORING' | 'MONITORING_READ_ONLY' | 'VIDEO_PIXEL_MONITORING' | 'TRACKING' | 'VPAID_MONITORING' | 'VPAID_BLOCKING' | 'NON_VPAID_MONITORING' | 'VPAID_ONLY_MONITORING' | 'VPAID_ONLY_BLOCKING' | 'VPAID_ONLY_FILTERING' | 'VPAID_FILTERING' | 'NON_VPAID_FILTERING' | 'BLOCKING_FILTERING_VPAID' | 'BLOCKING_FILTERING_VPAID_ONLY': Measurement mode for the wrapped placement. - `wrappedTag` string: Tag provided by the measurement partner during wrapping. - `paymentApproved` boolean: 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': Payment source for this placement. This is a required field that is read-only after insertion. - `placementGroupId` string, int64: ID of this placement's group, if applicable. - `placementGroupIdDimensionValue` DimensionValue: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `placementStrategyId` string, int64: ID of the placement strategy assigned to this placement. - `pricingSchedule` PricingSchedule: Pricing Schedule - `capCostOption` 'CAP_COST_NONE' | 'CAP_COST_MONTHLY' | 'CAP_COST_CUMULATIVE': Placement cap cost option. - `endDate` string, date - `flighted` boolean: Whether this placement is flighted. If true, pricing periods will be computed automatically. - `floodlightActivityId` string, int64: Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA. - `pricingPeriods` PricingSchedulePricingPeriod[]: Pricing periods for this placement. - `endDate` string, date - `pricingComment` string: Comments for this pricing period. - `rateOrCostNanos` string, int64: Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. - `startDate` string, date - `units` string, int64: Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. - `pricingType` 'PRICING_TYPE_CPM' | 'PRICING_TYPE_CPC' | 'PRICING_TYPE_CPA' | 'PRICING_TYPE_FLAT_RATE_IMPRESSIONS' | 'PRICING_TYPE_FLAT_RATE_CLICKS' | 'PRICING_TYPE_CPM_ACTIVEVIEW': Placement pricing type. This field is required on insertion. - `startDate` string, date - `testingStartDate` string, date - `primary` boolean: 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: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `siteId` string, int64: 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: Represents a DimensionValue resource. - `dimensionName` string: The name of the dimension. - `etag` string: The eTag of this response for caching purposes. - `id` string: The ID associated with the value if available. - `kind` string: The kind of resource this is, in this case dfareporting#dimensionValue. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION': Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `value` string: The value of the dimension. - `siteServed` boolean: 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. - `size` Size: Represents the dimensions of ads, placements, creatives, or creative assets. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `sslRequired` boolean: Whether creatives assigned to this placement must be SSL-compliant. - `status` 'PENDING_REVIEW' | 'PAYMENT_ACCEPTED' | 'PAYMENT_REJECTED' | 'ACKNOWLEDGE_REJECTION' | 'ACKNOWLEDGE_ACCEPTANCE' | 'DRAFT': Third-party placement status. - `subaccountId` string, int64: Subaccount ID of this placement. This field can be left blank. - `tagFormats` string[]: 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: Tag Settings - `additionalKeyValues` string: Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field. - `includeClickThroughUrls` boolean: Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site. - `includeClickTracking` boolean: Whether click-tracking string should be included in the tags. - `includeUnescapedlpurlMacro` boolean: Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site. - `keywordOption` 'PLACEHOLDER_WITH_LIST_OF_KEYWORDS' | 'IGNORE' | 'GENERATE_SEPARATE_TAG_FOR_EACH_KEYWORD': Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders. - `videoActiveViewOptOut` boolean: 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: Video Settings - `companionSettings` CompanionSetting: Companion Settings - `companionsDisabled` boolean: Whether companions are disabled for this placement. - `enabledSizes` Size[]: Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `imageOnly` boolean: Whether to serve only static images as companions. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#companionSetting". - `durationSeconds` integer: Duration of a video placement in seconds. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#videoSettings". - `obaEnabled` boolean: Whether OBA icons are enabled for this placement. - `obaSettings` ObaIcon: Online Behavioral Advertiser icon. - `iconClickThroughUrl` string: URL to redirect to when an OBA icon is clicked. - `iconClickTrackingUrl` string: URL to track click when an OBA icon is clicked. - `iconViewTrackingUrl` string: URL to track view when an OBA icon is clicked. - `program` string: Identifies the industry initiative that the icon supports. For example, AdChoices. - `resourceUrl` string: OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more - `size` Size: Represents the dimensions of ads, placements, creatives, or creative assets. - `height` integer: Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean: IAB standard size. This is a read-only, auto-generated field. - `id` string, int64: ID of this size. This is a read-only, auto-generated field. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `width` integer: Width of this size. Acceptable values are 0 to 32767, inclusive. - `xPosition` string: OBA icon x coordinate position. Accepted values are left or right. - `yPosition` string: OBA icon y coordinate position. Accepted values are top or bottom. - `orientation` 'ANY' | 'LANDSCAPE' | 'PORTRAIT': Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation. - `publisherSpecificationId` string, int64: Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max - `skippableSettings` SkippableSetting: Skippable Settings - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#skippableSetting". - `progressOffset` VideoOffset: Video Offset - `offsetPercentage` integer: Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - `offsetSeconds` integer: Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - `skipOffset` VideoOffset: Video Offset - `offsetPercentage` integer: Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - `offsetSeconds` integer: Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - `skippable` boolean: Whether the user can skip creatives served to this placement. - `transcodeSettings` TranscodeSetting: Transcode Settings - `enabledVideoFormats` integer[]: Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". - `vpaidAdapterChoice` 'DEFAULT' | 'FLASH' | 'HTML5' | 'BOTH': 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: Whether this placement opts out of tag wrapping. - `youtubeSettings` YoutubeSettings: Contains the YouTube settings. - `businessLogoCreativeIds` string[]: Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported. - `businessName` string: Optional. The business name. - `callToActions` string[]: Optional. The call to actions. Currently only one call to action is supported. - `descriptions` string[]: Optional. The descriptions. Currently only one description is supported. - `headlines` string[]: Optional. The headlines associated with the call to actions. Currently only one headline is supported. - `longHeadlines` string[]: Optional. The long headlines. Currently only one long headline is supported. --- [API](https://skmtc.dev/google/apis/dfareporting.md) - [All operations](https://skmtc.dev/google/apis/dfareporting/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/dfareporting/revisions/be73a9a450de?raw)