Placements: list

Requires authorization

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

Request

HTTP request

GET https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/placements

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
advertiserIds long Select only placements that belong to these advertisers.
archived boolean Select only archived placements. Don't set this field to select both archived and non-archived placements.
campaignIds long Select only placements that belong to these campaigns.
compatibilities string Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.

Acceptable values are:
  • "APP"
  • "APP_INTERSTITIAL"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL"
  • "IN_STREAM_VIDEO"
contentCategoryIds long Select only placements that are associated with these content categories.
directorySiteIds long Select only placements that are associated with these directory sites.
groupIds long Select only placements that belong to these placement groups.
ids long Select only placements with these IDs.
maxEndDate string 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".
maxResults integer Maximum number of results to return. Acceptable values are 0 to 1000, inclusive. (Default: 1000)
maxStartDate string 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".
minEndDate string 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".
minStartDate string 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".
pageToken string Value of the nextPageToken from the previous result page.
paymentSource string Select only placements with this payment source.

Acceptable values are:
  • "PLACEMENT_AGENCY_PAID"
  • "PLACEMENT_PUBLISHER_PAID"
placementStrategyIds long Select only placements that are associated with these placement strategies.
pricingTypes string Select only placements with these pricing types.

Acceptable values are:
  • "PRICING_TYPE_CPA"
  • "PRICING_TYPE_CPC"
  • "PRICING_TYPE_CPM"
  • "PRICING_TYPE_CPM_ACTIVEVIEW"
  • "PRICING_TYPE_FLAT_RATE_CLICKS"
  • "PRICING_TYPE_FLAT_RATE_IMPRESSIONS"
searchString string Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement 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 "placement" will match placements with name "my placement", "placement 2015", or simply "placement".
siteIds long Select only placements that are associated with these sites.
sizeIds long Select only placements that are associated with these sizes.
sortField string Field by which to sort the list.

Acceptable values are:
  • "ID" (default)
  • "NAME"
sortOrder string Order of sorted results.

Acceptable values are:
  • "ASCENDING" (default)
  • "DESCENDING"

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/dfatrafficking

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "dfareporting#placementsListResponse",
  "nextPageToken": string,
  "placements": [
    placements Resource
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsListResponse".
placements[] list Placement collection.
nextPageToken string Pagination token to be used for the next list operation.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager