--- title: "GET /userprofiles/{userprofilesId}/placementGroups" method: GET path: "/userprofiles/{userprofilesId}/placementGroups" tags: ["placementGroups"] --- # GET /userprofiles/{userprofilesId}/placementGroups `GET /userprofiles/{userprofilesId}/placementGroups` ## Request - Base URL: `https://dfareporting.googleapis.com/dfareporting/v5` - URL: `https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{userprofilesId}/placementGroups` - 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) Retrieves a list of placement groups, possibly filtered. This method supports paging. ## Path parameters - `userprofilesId` string, required ## Query parameters - `activeStatus` string[] - `advertiserIds` string[] - `campaignIds` string[] - `contentCategoryIds` string[] - `directorySiteIds` string[] - `ids` string[] - `maxEndDate` string - `maxResults` integer - `maxStartDate` string - `minEndDate` string - `minStartDate` string - `pageToken` string - `placementGroupType` 'PLACEMENT_PACKAGE' | 'PLACEMENT_ROADBLOCK' - `placementStrategyIds` string[] - `pricingTypes` string[] - `searchString` string - `siteIds` string[] - `sortField` 'ID' | 'NAME' - `sortOrder` 'ASCENDING' | 'DESCENDING' ## Response `200` Successful response - PlacementGroupsListResponse: Placement Group List Response - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroupsListResponse". - `nextPageToken` string: Pagination token to be used for the next list operation. - `placementGroups` PlacementGroup[]: Placement group collection. - `accountId` string, int64: Account ID of this placement group. This is a read-only field that can be left blank. - `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. - `advertiserId` string, int64: Advertiser ID of this placement group. This is a required field on insertion. - `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. - `campaignId` string, int64: Campaign ID of this placement group. This field is required 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. - `childPlacementIds` string[]: IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field. - `comment` string: Comments for this placement group. - `contentCategoryId` string, int64: ID of the content category assigned to this placement group. - `createInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `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. - `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 group. 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. - `kind` string: Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementGroup". - `lastModifiedInfo` LastModifiedInfo: Modification timestamp. - `time` string, int64: Timestamp of the last change in milliseconds since epoch. - `name` string: Name of this placement group. This is a required field and must be less than 256 characters long. - `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. - `placementStrategyId` string, int64: ID of the placement strategy assigned to this placement group. - `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 - `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. - `primaryPlacementIdDimensionValue` 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. - `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. - `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. - `subaccountId` string, int64: Subaccount ID of this placement group. This is a read-only field that can be left blank. --- [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)