Retrieves a list of placements, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v3.4/userprofiles/{profileId}/placements
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
User profile ID associated with this request. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only placements with these IDs. |
advertiserIds[] |
Select only placements that belong to these advertisers. |
campaignIds[] |
Select only placements that belong to these campaigns. |
siteIds[] |
Select only placements that are associated with these sites. |
directorySiteIds[] |
Select only placements that are associated with these directory sites. |
placementStrategyIds[] |
Select only placements that are associated with these placement strategies. |
contentCategoryIds[] |
Select only placements that are associated with these content categories. |
compatibilities[] |
Select only placements that are associated with these compatibilities.
and
refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively.
and
are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. |
sizeIds[] |
Select only placements that are associated with these sizes. |
pricingTypes[] |
Select only placements with these pricing types. |
archived |
Select only archived placements. Don't set this field to select both archived and non-archived placements. |
paymentSource |
Select only placements with this payment source. |
searchString |
Allows searching for placements by name or ID. Wildcards (
) are allowed. For example,
will return placements with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match placements with name
,
, or simply
. |
groupIds[] |
Select only placements that belong to these placement groups. |
maxEndDate |
Select only placements or placement groups whose end date is on or before the specified
. The date should be formatted as "yyyy-MM-dd". |
maxResults |
Maximum number of results to return. |
maxStartDate |
Select only placements or placement groups whose start date is on or before the specified
. The date should be formatted as "yyyy-MM-dd". |
minEndDate |
Select only placements or placement groups whose end date is on or after the specified
. The date should be formatted as "yyyy-MM-dd". |
minStartDate |
Select only placements or placement groups whose start date is on or after the specified
. The date should be formatted as "yyyy-MM-dd". |
pageToken |
Value of the
from the previous result page. |
sortField |
Field by which to sort the list. |
sortOrder |
Order of sorted results. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Placement accountPermissionGroups.list Response
JSON representation | |
---|---|
{
"kind": string,
"nextPageToken": string,
"placements": [
{
object ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
nextPageToken |
Pagination token to be used for the next list operation. |
placements[] |
Placement collection. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
Compatibilities
Enums | |
---|---|
DISPLAY |
|
DISPLAY_INTERSTITIAL |
|
APP |
|
APP_INTERSTITIAL |
|
IN_STREAM_VIDEO |
|
IN_STREAM_AUDIO |
PricingTypes
Enums | |
---|---|
PRICING_TYPE_CPM |
|
PRICING_TYPE_CPC |
|
PRICING_TYPE_CPA |
|
PRICING_TYPE_FLAT_RATE_IMPRESSIONS |
|
PRICING_TYPE_FLAT_RATE_CLICKS |
|
PRICING_TYPE_CPM_ACTIVEVIEW |
PaymentSource
Enums | |
---|---|
PLACEMENT_AGENCY_PAID |
|
PLACEMENT_PUBLISHER_PAID |
SortField
Enums | |
---|---|
ID |
|
NAME |
SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |