List

Retrieves a list of placement groups, possibly filtered

20 variables
76 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns

Input

This building block consumes 20 input parameters

  = Parameter name
  = Format

profileId INTEGER Required

User profile ID associated with this request

advertiserIds INTEGER

Select only placement groups 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 INTEGER

Select only placement groups that belong to these campaigns

contentCategoryIds INTEGER

Select only placement groups that are associated with these content categories

directorySiteIds INTEGER

Select only placement groups that are associated with these directory sites

ids INTEGER

Select only placement groups 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

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

placementGroupType ENUMERATION

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

placementStrategyIds INTEGER

Select only placement groups that are associated with these placement strategies

pricingTypes ENUMERATION

Select only placement groups with these pricing types

searchString STRING

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"

siteIds INTEGER

Select only placement groups that are associated with these sites

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

Output

This building block provides 76 output parameters

  = Parameter name
  = Format

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[] OBJECT

Contains properties of a package or roadblock

placementGroups[].accountId INTEGER

Account ID of this placement group. This is a read-only field that can be left blank

placementGroups[].advertiserId INTEGER

Advertiser ID of this placement group. This is a required field on insertion

placementGroups[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

placementGroups[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

placementGroups[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroups[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

placementGroups[].advertiserIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementGroups[].advertiserIdDimensionValue.matchType ENUMERATION

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

placementGroups[].advertiserIdDimensionValue.value STRING

The value of the dimension

placementGroups[].archived BOOLEAN

Whether this placement group is archived

placementGroups[].campaignId INTEGER

Campaign ID of this placement group. This field is required on insertion

placementGroups[].campaignIdDimensionValue OBJECT

Represents a DimensionValue resource

placementGroups[].campaignIdDimensionValue.dimensionName STRING

The name of the dimension

placementGroups[].campaignIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroups[].campaignIdDimensionValue.id STRING

The ID associated with the value if available

placementGroups[].campaignIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementGroups[].campaignIdDimensionValue.matchType ENUMERATION

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

placementGroups[].campaignIdDimensionValue.value STRING

The value of the dimension

placementGroups[].childPlacementIds[] INTEGER

placementGroups[].comment STRING

Comments for this placement group

placementGroups[].contentCategoryId INTEGER

ID of the content category assigned to this placement group

placementGroups[].createInfo OBJECT

Modification timestamp

placementGroups[].createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

placementGroups[].directorySiteId INTEGER

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

placementGroups[].directorySiteIdDimensionValue OBJECT

Represents a DimensionValue resource

placementGroups[].directorySiteIdDimensionValue.dimensionName STRING

The name of the dimension

placementGroups[].directorySiteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroups[].directorySiteIdDimensionValue.id STRING

The ID associated with the value if available

placementGroups[].directorySiteIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementGroups[].directorySiteIdDimensionValue.matchType ENUMERATION

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

placementGroups[].directorySiteIdDimensionValue.value STRING

The value of the dimension

placementGroups[].externalId STRING

External ID for this placement

placementGroups[].id INTEGER

ID of this placement group. This is a read-only, auto-generated field

placementGroups[].idDimensionValue OBJECT

Represents a DimensionValue resource

placementGroups[].idDimensionValue.dimensionName STRING

The name of the dimension

placementGroups[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroups[].idDimensionValue.id STRING

The ID associated with the value if available

placementGroups[].idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementGroups[].idDimensionValue.matchType ENUMERATION

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

placementGroups[].idDimensionValue.value STRING

The value of the dimension

placementGroups[].kind STRING

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

placementGroups[].lastModifiedInfo OBJECT

Modification timestamp

placementGroups[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

placementGroups[].name STRING

Name of this placement group. This is a required field and must be less than 256 characters long

placementGroups[].placementGroupType ENUMERATION

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

placementGroups[].placementStrategyId INTEGER

ID of the placement strategy assigned to this placement group

placementGroups[].pricingSchedule OBJECT

Pricing Schedule

placementGroups[].pricingSchedule.capCostOption ENUMERATION

Placement cap cost option

placementGroups[].pricingSchedule.disregardOverdelivery BOOLEAN

Whether cap costs are ignored by ad serving

placementGroups[].pricingSchedule.endDate DATE

Placement end date. This date must be later than, or the same day as, the placement start date, but not later than the campaign end date. If, for example, you set 6/25/2015 as both the start and end dates, the effective placement date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This field is required on insertion

placementGroups[].pricingSchedule.flighted BOOLEAN

Whether this placement is flighted. If true, pricing periods will be computed automatically

placementGroups[].pricingSchedule.floodlightActivityId INTEGER

Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA

placementGroups[].pricingSchedule.pricingPeriods[] OBJECT

Pricing Period

placementGroups[].pricingSchedule.pricingType ENUMERATION

Placement pricing type. This field is required on insertion

placementGroups[].pricingSchedule.startDate DATE

Placement start date. This date must be later than, or the same day as, the campaign start date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This field is required on insertion

placementGroups[].pricingSchedule.testingStartDate DATE

Testing start date of this placement. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error

placementGroups[].primaryPlacementId INTEGER

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

placementGroups[].primaryPlacementIdDimensionValue OBJECT

Represents a DimensionValue resource

placementGroups[].primaryPlacementIdDimensionValue.dimensionName STRING

The name of the dimension

placementGroups[].primaryPlacementIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroups[].primaryPlacementIdDimensionValue.id STRING

The ID associated with the value if available

placementGroups[].primaryPlacementIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementGroups[].primaryPlacementIdDimensionValue.matchType ENUMERATION

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

placementGroups[].primaryPlacementIdDimensionValue.value STRING

The value of the dimension

placementGroups[].siteId INTEGER

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

placementGroups[].siteIdDimensionValue OBJECT

Represents a DimensionValue resource

placementGroups[].siteIdDimensionValue.dimensionName STRING

The name of the dimension

placementGroups[].siteIdDimensionValue.etag STRING

The eTag of this response for caching purposes

placementGroups[].siteIdDimensionValue.id STRING

The ID associated with the value if available

placementGroups[].siteIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

placementGroups[].siteIdDimensionValue.matchType ENUMERATION

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

placementGroups[].siteIdDimensionValue.value STRING

The value of the dimension

placementGroups[].subaccountId INTEGER

Subaccount ID of this placement group. This is a read-only field that can be left blank