dfareporting.placements.list
GET {{baseUrl}}/userprofiles/:profileId/placements?advertiserIds=<string>&advertiserIds=<string>&archived=<boolean>&campaignIds=<string>&campaignIds=<string>&compatibilities=<string>&compatibilities=<string>&contentCategoryIds=<string>&contentCategoryIds=<string>&directorySiteIds=<string>&directorySiteIds=<string>&groupIds=<string>&groupIds=<string>&ids=<string>&ids=<string>&maxEndDate=<string>&maxResults=<integer>&maxStartDate=<string>&minEndDate=<string>&minStartDate=<string>&pageToken=<string>&paymentSource=<string>&placementStrategyIds=<string>&placementStrategyIds=<string>&pricingTypes=<string>&pricingTypes=<string>&searchString=<string>&siteIds=<string>&siteIds=<string>&sizeIds=<string>&sizeIds=<string>&sortField=<string>&sortOrder=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Retrieves a list of placements, possibly filtered. This method supports paging.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
advertiserIds | string | Select only placements that belong to these advertisers. | |
advertiserIds | string | Select only placements that belong to these advertisers. | |
archived | string | Select only archived placements. Don't set this field to select both archived and non-archived placements. | |
campaignIds | string | Select only placements that belong to these campaigns. | |
campaignIds | string | 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. | |
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. | |
contentCategoryIds | string | Select only placements that are associated with these content categories. | |
contentCategoryIds | string | Select only placements that are associated with these content categories. | |
directorySiteIds | string | Select only placements that are associated with these directory sites. | |
directorySiteIds | string | Select only placements that are associated with these directory sites. | |
groupIds | string | Select only placements that belong to these placement groups. | |
groupIds | string | Select only placements that belong to these placement groups. | |
ids | string | Select only placements with these IDs. | |
ids | string | 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 | string | Maximum number of results to return. | |
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. | |
placementStrategyIds | string | Select only placements that are associated with these placement strategies. | |
placementStrategyIds | string | Select only placements that are associated with these placement strategies. | |
pricingTypes | string | Select only placements with these pricing types. | |
pricingTypes | string | Select only placements with these pricing types. | |
searchString | string | Allows searching for placements by name or ID. Wildcards () are allowed. For example, "placement2015" 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 | string | Select only placements that are associated with these sites. | |
siteIds | string | Select only placements that are associated with these sites. | |
sizeIds | string | Select only placements that are associated with these sizes. | |
sizeIds | string | Select only placements that are associated with these sizes. | |
sortField | string | Field by which to sort the list. | |
sortOrder | string | Order of sorted results. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"kind":"irure","nextPageToken":"laborum qui amet","placements":[{"accountId":"magna in","adBlockingOptOut":false,"additionalSizes":[{"height":-52808164,"iab":false,"id":"dolore ad","kind":"ad ipsum eu","width":-29484090},{"height":82484784,"iab":true,"id":"proident dolor Ut","kind":"amet","width":81325555}],"advertiserId":"exercitation eiusmod","advertiserIdDimensionValue":{"dimensionName":"laborum sint dolore in L","etag":"eiusmod","id":"aliqua","kind":"enim in","matchType":"EXACT","value":"anim Ut ut"},"archived":false,"campaignId":"commodo consectetur","campaignIdDimensionValue":{"dimensionName":"enim","etag":"Excep","id":"exercitation dolore consequat ad","kind":"magna tempor","matchType":"EXACT","value":"Duis irure do et"},"comment":"Ut","compatibility":"DISPLAY","contentCategoryId":"ea","createInfo":{"time":"amet elit id"},"directorySiteId":"fugiat dolore","directorySiteIdDimensionValue":{"dimensionName":"commodo nulla","etag":"eu nostrud id exercitation","id":"do Ut occaecat","kind":"Lorem Duis in laboris qui","matchType":"WILDCARD_EXPRESSION","value":"sit sed ea"},"externalId":"tempor sunt eu","id":"deseru","idDimensionValue":{"dimensionName":"irure voluptate","etag":"do non exercitation","id":"qui ullamco","kind":"eiusmod","matchType":"EXACT","value":"ut cillum tempor Ut"},"keyName":"proident Exc","kind":"Ut amet ea irure","lastModifiedInfo":{"time":"est non aute amet"},"lookbackConfiguration":{"clickDuration":40778088,"postImpressionActivitiesDuration":14397854},"name":"nisi nostrud","paymentApproved":true,"paymentSource":"PLACEMENT_AGENCY_PAID","placementGroupId":"ad laborum","placementGroupIdDimensionValue":{"dimensionName":"non proident ut","etag":"in laborum ut pariatur est","id":"exercitation Duis in","kind":"ullamco incididunt proident","matchType":"WILDCARD_EXPRESSION","value":"irure anim mollit commodo"},"placementStrategyId":"officia reprehenderit","pricingSchedule":{"capCostOption":"CAP_COST_CUMULATIVE","endDate":"1941-01-18","flighted":false,"floodlightActivityId":"aute ea","pricingPeriods":[{"endDate":"1986-07-12","pricingComment":"esse deserunt","rateOrCostNanos":"eu labore cupidatat nulla sit","startDate":"1971-01-03","units":"consequat"},{"endDate":"1952-09-08","pricingComment":"nostrud","rateOrCostNanos":"sit eiusmod adipisicing ex","startDate":"1968-10-27","units":"commodo ullamco fugiat"}],"pricingType":"PRICING_TYPE_FLAT_RATE_CLICKS","startDate":"2008-05-22","testingStartDate":"2006-01-26"},"primary":true,"publisherUpdateInfo":{"time":"exercitation eiusmod"},"siteId":"Ut consequat elit culpa veniam","siteIdDimensionValue":{"dimensionName":"cupidatat est sint enim consectetur","etag":"laboris irure","id":"quis ea non cillum","kind":"ea","matchType":"EXACT","value":"cupidatat"},"size":{"height":34226987,"iab":false,"id":"nostrud laborum nulla","kind":"tempor eiusmod enim nulla","width":-45493105},"sslRequired":false,"status":"DRAFT","subaccountId":"aliqua eu magna adipisicing aliquip","tagFormats":["PLACEMENT_TAG_IFRAME_JAVASCRIPT","PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"],"tagSetting":{"additionalKeyValues":"qui aliqua","includeClickThroughUrls":false,"includeClickTracking":false,"keywordOption":"PLACEHOLDER_WITH_LIST_OF_KEYWORDS"},"videoActiveViewOptOut":false,"videoSettings":{"companionSettings":{"companionsDisabled":true,"enabledSizes":[{"height":-24647801,"iab":true,"id":"tempor amet est","kind":"officia nisi","width":-8317785},{"height":90630596,"iab":false,"id":"incididunt esse labore","kind":"sunt Duis","width":-48820129}],"imageOnly":true,"kind":"quis do dolor elit"},"kind":"culpa dolor veniam","obaEnabled":false,"obaSettings":{"iconClickThroughUrl":"nisi","iconClickTrackingUrl":"eu","iconViewTrackingUrl":"labore Ut veniam","program":"aute occaecat magna voluptate qui","resourceUrl":"Duis amet mollit","size":{"height":-50163086,"iab":true,"id":"ex","kind":"veni","width":46077440},"xPosition":"esse","yPosition":"adipisic"},"orientation":"PORTRAIT","skippableSettings":{"kind":"deserunt ex","progressOffset":{"offsetPercentage":-48094541,"offsetSeconds":83327615},"skipOffset":{"offsetPercentage":-20845590,"offsetSeconds":-81749780},"skippable":true},"transcodeSettings":{"enabledVideoFormats":[-24691374,20979643],"kind":"mollit aliquip"}},"vpaidAdapterChoice":"BOTH"},{"accountId":"aute voluptate","adBlockingOptOut":false,"additionalSizes":[{"height":-84247957,"iab":false,"id":"incididunt occaecat","kind":"id pariatur dolore in","width":-83363306},{"height":2873723,"iab":true,"id":"sunt qui","kind":"veniam ","width":66037148}],"advertiserId":"id dolor irure","advertiserIdDimensionValue":{"dimensionName":"enim mollit minim","etag":"reprehenderit anim ex ut","id":"sunt eu","kind":"culpa Dui","matchType":"WILDCARD_EXPRESSION","value":"occaecat ex sunt amet labore"},"archived":false,"campaignId":"reprehenderit nulla ad","campaignIdDimensionValue":{"dimensionName":"eiusmo","etag":"dolore officia aute proident","id":"aliquip aute","kind":"tempor et in dolore","matchType":"BEGINS_WITH","value":"do aliquip"},"comment":"sed","compatibility":"APP_INTERSTITIAL","contentCategoryId":"consequat","createInfo":{"time":"nostrud Ut"},"directorySiteId":"non esse fugiat","directorySiteIdDimensionValue":{"dimensionName":"veniam irure","etag":"proident ex cupidatat","id":"eu","kind":"veniam ut adipisicing","matchType":"EXACT","value":"mollit tempor adipisicing"},"externalId":"quis et occaecat","id":"quis voluptate eu","idDimensionValue":{"dimensionName":"voluptate occaecat et","etag":"eiusmod","id":"Duis eiusmod tempor","kind":"incididunt ex cillum enim","matchType":"CONTAINS","value":"dolore aliquip sunt do"},"keyName":"est in consequat dolore tempor","kind":"minim","lastModifiedInfo":{"time":"in exercitation"},"lookbackConfiguration":{"clickDuration":-17909253,"postImpressionActivitiesDuration":83767417},"name":"occaecat in","paymentApproved":true,"paymentSource":"PLACEMENT_AGENCY_PAID","placementGroupId":"est consectetur occaecat Duis","placementGroupIdDimensionValue":{"dimensionName":"sint minim officia quis","etag":"consequat commodo","id":"esse Lorem magna exercitation","kind":"ullamco ","matchType":"EXACT","value":"minim"},"placementStrategyId":"cupidatat","pricingSchedule":{"capCostOption":"CAP_COST_MONTHLY","endDate":"1943-06-18","flighted":false,"floodlightActivityId":"minim cillum labore","pricingPeriods":[{"endDate":"1979-01-21","pricingComment":"consequat in cillum","rateOrCostNanos":"Excepteur dolore","startDate":"1956-06-01","units":"esse anim pa"},{"endDate":"1997-10-22","pricingComment":"eu sint","rateOrCostNanos":"occaecat pariatur officia anim sit","startDate":"1943-03-23","units":"minim eu"}],"pricingType":"PRICING_TYPE_FLAT_RATE_IMPRESSIONS","startDate":"1962-02-01","testingStartDate":"1974-09-28"},"primary":true,"publisherUpdateInfo":{"time":"consequat sunt"},"siteId":"nulla deserunt consectetur quis","siteIdDimensionValue":{"dimensionName":"sint in Lorem ipsum","etag":"eu ad ","id":"aute","kind":"eu Ut","matchType":"BEGINS_WITH","value":"amet ipsum qui esse"},"size":{"height":74590601,"iab":true,"id":"sint dolor ullamco veniam","kind":"amet anim ullamco","width":-87531136},"sslRequired":false,"status":"DRAFT","subaccountId":"culpa Excepteur","tagFormats":["PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY","PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"],"tagSetting":{"additionalKeyValues":"enim elit aliquip","includeClickThroughUrls":false,"includeClickTracking":true,"keywordOption":"PLACEHOLDER_WITH_LIST_OF_KEYWORDS"},"videoActiveViewOptOut":true,"videoSettings":{"companionSettings":{"companionsDisabled":false,"enabledSizes":[{"height":79738102,"iab":true,"id":"exercitation labore ut","kind":"deserunt esse occaecat","width":14816338},{"height":-78440763,"iab":false,"id":"deserunt ut aute minim sint","kind":"elit Lorem esse","width":78934309}],"imageOnly":false,"kind":"qui commodo ex"},"kind":"labore tempor nisi","obaEnabled":false,"obaSettings":{"iconClickThroughUrl":"Duis ullamco deserunt in","iconClickTrackingUrl":"aliqua","iconViewTrackingUrl":"et occaecat Lorem ut","program":"et in Lorem dolor dolor","resourceUrl":"pro","size":{"height":-35850717,"iab":false,"id":"ipsum id labore amet","kind":"dolore ullamco","width":89110222},"xPosition":"amet consequat","yPosition":"sed dolor"},"orientation":"LANDSCAPE","skippableSettings":{"kind":"ipsum sunt cillum esse non","progressOffset":{"offsetPercentage":54581189,"offsetSeconds":-61754225},"skipOffset":{"offsetPercentage":92269567,"offsetSeconds":41281425},"skippable":true},"transcodeSettings":{"enabledVideoFormats":[47262395,-20338145],"kind":"aute et in ipsum proident"}},"vpaidAdapterChoice":"BOTH"}]}