--- title: "PATCH /userprofiles/{+profileId}/placementGroups" method: PATCH path: "/userprofiles/{+profileId}/placementGroups" tags: ["placementGroups"] --- # PATCH /userprofiles/{+profileId}/placementGroups `PATCH /userprofiles/{+profileId}/placementGroups` Updates an existing placement group. This method supports patch semantics. ## Path parameters - `profileId` string, required ## Query parameters - `id` string, required ## Request body - PlacementGroup — Contains properties of a package or roadblock. - `externalId` string — External ID for this placement. - `childPlacementIds` string[] — IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. - `createInfo` LastModifiedInfo — Modification timestamp. - `time` string, int64 — Timestamp of the last change in milliseconds since epoch. - `idDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `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. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `placementGroupType` 'PLACEMENT_PACKAGE' | 'PLACEMENT_ROADBLOCK' — Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. - `pricingSchedule` PricingSchedule — Pricing Schedule - `flighted` boolean — Whether this placement is flighted. If true, pricing periods will be computed automatically. - `capCostOption` 'CAP_COST_NONE' | 'CAP_COST_MONTHLY' | 'CAP_COST_CUMULATIVE' — Placement cap cost option. - `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. - `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. - `testingStartDate` string, date - `endDate` string, date - `startDate` string, date - `pricingPeriods` PricingSchedulePricingPeriod[] — Pricing periods for this placement. - `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. - `endDate` string, date - `startDate` string, date - `units` string, int64 — Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive. - `comment` string — Comments for this placement group. - `directorySiteId` string, int64 — Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. - `advertiserId` string, int64 — Advertiser ID of this placement group. This is a required field on insertion. - `siteId` string, int64 — Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. - `siteIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `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. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `primaryPlacementId` string, int64 — ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. - `campaignId` string, int64 — Campaign ID of this placement group. This field is required on insertion. - `advertiserIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `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. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `placementStrategyId` string, int64 — ID of the placement strategy assigned to this placement group. - `activeStatus` 'PLACEMENT_STATUS_UNKNOWN' | 'PLACEMENT_STATUS_ACTIVE' | 'PLACEMENT_STATUS_INACTIVE' | 'PLACEMENT_STATUS_ARCHIVED' | 'PLACEMENT_STATUS_PERMANENTLY_ARCHIVED' — Whether this placement group is active, inactive, archived or permanently archived. - `lastModifiedInfo` LastModifiedInfo — Modification timestamp. - `time` string, int64 — Timestamp of the last change in milliseconds since epoch. - `id` string, int64 — ID of this placement group. This is a read-only, auto-generated field. - `contentCategoryId` string, int64 — ID of the content category assigned to this placement group. - `directorySiteIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `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. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `subaccountId` string, int64 — Subaccount ID of this placement group. This is a read-only field that can be left blank. - `primaryPlacementIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `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. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". - `campaignIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `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. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `name` string — Name of this placement group. This is a required field and must be less than 256 characters long. - `accountId` string, int64 — Account ID of this placement group. This is a read-only field that can be left blank. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dfareporting.md) · [All operations](https://skmtc.net/google/apis/dfareporting/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dfareporting/versions/8163d57aeb31/schema)