GOgoogle
placementGroups

GET /userprofiles/{userprofilesId}/placementGroups

Retrieves a list of placement groups, possibly filtered. This method supports paging.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Query parameters

activeStatusstring[]

Select only placements with these active statuses.

advertiserIdsstring[]

Select only placement groups that belong to these advertisers.

campaignIdsstring[]

Select only placement groups that belong to these campaigns.

contentCategoryIdsstring[]

Select only placement groups that are associated with these content categories.

directorySiteIdsstring[]

Select only placement groups that are associated with these directory sites.

idsstring[]

Select only placement groups with these IDs.

maxEndDatestring

Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

maxResultsinteger

Maximum number of results to return.

maxStartDatestring

Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

minEndDatestring

Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

minStartDatestring

Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

pageTokenstring

Value of the nextPageToken from the previous result page.

placementGroupType'PLACEMENT_PACKAGE' | 'PLACEMENT_ROADBLOCK'

Select only placement groups belonging with this group type. 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.

placementStrategyIdsstring[]

Select only placement groups that are associated with these placement strategies.

pricingTypesstring[]

Select only placement groups with these pricing types.

searchStringstring

Allows searching for placement groups by name or ID. Wildcards () are allowed. For example, "placement2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".

siteIdsstring[]

Select only placement groups that are associated with these sites.

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

Response

Successful response

kindstring

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

nextPageTokenstring

Pagination token to be used for the next list operation.

Changes

No recorded changes to this operation across all 5 revisions of this API.