Dfareporting.PlacementGroups.List (Campaign Manager 360 API v5-rev20250902-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.dfareporting.DfareportingRequest<PlacementGroupsListResponse>
        
        com.google.api.services.dfareporting.Dfareporting.PlacementGroups.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Dfareporting.PlacementGroups

public class Dfareporting.PlacementGroups.List
extends DfareportingRequest<PlacementGroupsListResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(Long profileId)
Retrieves a list of placement groups, possibly filtered.

Constructors
Modifier	Constructor and Description
`protected`	`List(Long profileId)` Retrieves a list of placement groups, possibly filtered.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`List<String>`	`getActiveStatus()` Select only placements with these active statuses.
`List<Long>`	`getAdvertiserIds()` Select only placement groups that belong to these advertisers.
`List<Long>`	`getCampaignIds()` Select only placement groups that belong to these campaigns.
`List<Long>`	`getContentCategoryIds()` Select only placement groups that are associated with these content categories.
`List<Long>`	`getDirectorySiteIds()` Select only placement groups that are associated with these directory sites.
`List<Long>`	`getIds()` Select only placement groups with these IDs.
`String`	`getMaxEndDate()` Select only placements or placement groups whose end date is on or before the specified maxEndDate.
`Integer`	`getMaxResults()` Maximum number of results to return.
`String`	`getMaxStartDate()` Select only placements or placement groups whose start date is on or before the specified maxStartDate.
`String`	`getMinEndDate()` Select only placements or placement groups whose end date is on or after the specified minEndDate.
`String`	`getMinStartDate()` Select only placements or placement groups whose start date is on or after the specified minStartDate.
`String`	`getPageToken()` Value of the nextPageToken from the previous result page.
`String`	`getPlacementGroupType()` Select only placement groups belonging with this group type.
`List<Long>`	`getPlacementStrategyIds()` Select only placement groups that are associated with these placement strategies.
`List<String>`	`getPricingTypes()` Select only placement groups with these pricing types.
`Long`	`getProfileId()` User profile ID associated with this request.
`String`	`getSearchString()` Allows searching for placement groups by name or ID.
`List<Long>`	`getSiteIds()` Select only placement groups that are associated with these sites.
`String`	`getSortField()` Field by which to sort the list.
`String`	`getSortOrder()` Order of sorted results.
`Dfareporting.PlacementGroups.List`	`set(String parameterName, Object value)`
`Dfareporting.PlacementGroups.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Dfareporting.PlacementGroups.List`	`setAccessToken(String accessToken)` OAuth access token.
`Dfareporting.PlacementGroups.List`	`setActiveStatus(List<String> activeStatus)` Select only placements with these active statuses.
`Dfareporting.PlacementGroups.List`	`setAdvertiserIds(List<Long> advertiserIds)` Select only placement groups that belong to these advertisers.
`Dfareporting.PlacementGroups.List`	`setAlt(String alt)` Data format for response.
`Dfareporting.PlacementGroups.List`	`setCallback(String callback)` JSONP
`Dfareporting.PlacementGroups.List`	`setCampaignIds(List<Long> campaignIds)` Select only placement groups that belong to these campaigns.
`Dfareporting.PlacementGroups.List`	`setContentCategoryIds(List<Long> contentCategoryIds)` Select only placement groups that are associated with these content categories.
`Dfareporting.PlacementGroups.List`	`setDirectorySiteIds(List<Long> directorySiteIds)` Select only placement groups that are associated with these directory sites.
`Dfareporting.PlacementGroups.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Dfareporting.PlacementGroups.List`	`setIds(List<Long> ids)` Select only placement groups with these IDs.
`Dfareporting.PlacementGroups.List`	`setKey(String key)` API key.
`Dfareporting.PlacementGroups.List`	`setMaxEndDate(String maxEndDate)` Select only placements or placement groups whose end date is on or before the specified maxEndDate.
`Dfareporting.PlacementGroups.List`	`setMaxResults(Integer maxResults)` Maximum number of results to return.
`Dfareporting.PlacementGroups.List`	`setMaxStartDate(String maxStartDate)` Select only placements or placement groups whose start date is on or before the specified maxStartDate.
`Dfareporting.PlacementGroups.List`	`setMinEndDate(String minEndDate)` Select only placements or placement groups whose end date is on or after the specified minEndDate.
`Dfareporting.PlacementGroups.List`	`setMinStartDate(String minStartDate)` Select only placements or placement groups whose start date is on or after the specified minStartDate.
`Dfareporting.PlacementGroups.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Dfareporting.PlacementGroups.List`	`setPageToken(String pageToken)` Value of the nextPageToken from the previous result page.
`Dfareporting.PlacementGroups.List`	`setPlacementGroupType(String placementGroupType)` Select only placement groups belonging with this group type.
`Dfareporting.PlacementGroups.List`	`setPlacementStrategyIds(List<Long> placementStrategyIds)` Select only placement groups that are associated with these placement strategies.
`Dfareporting.PlacementGroups.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dfareporting.PlacementGroups.List`	`setPricingTypes(List<String> pricingTypes)` Select only placement groups with these pricing types.
`Dfareporting.PlacementGroups.List`	`setProfileId(Long profileId)` User profile ID associated with this request.
`Dfareporting.PlacementGroups.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Dfareporting.PlacementGroups.List`	`setSearchString(String searchString)` Allows searching for placement groups by name or ID.
`Dfareporting.PlacementGroups.List`	`setSiteIds(List<Long> siteIds)` Select only placement groups that are associated with these sites.
`Dfareporting.PlacementGroups.List`	`setSortField(String sortField)` Field by which to sort the list.
`Dfareporting.PlacementGroups.List`	`setSortOrder(String sortOrder)` Order of sorted results.
`Dfareporting.PlacementGroups.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Dfareporting.PlacementGroups.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(Long profileId)
```
    Retrieves a list of placement groups, possibly filtered. This method supports paging. Create a request for the method "placementGroups.list". This request holds the parameters needed by the the dfareporting server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Dfareporting.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    profileId - User profile ID associated with this request.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlacementGroupsListResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlacementGroupsListResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Dfareporting.PlacementGroups.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DfareportingRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DfareportingRequest<PlacementGroupsListResponse>
  - setAccessToken
```
public Dfareporting.PlacementGroups.List setAccessToken(String accessToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DfareportingRequest<PlacementGroupsListResponse>
  - setAlt
```
public Dfareporting.PlacementGroups.List setAlt(String alt)
```
    Description copied from class: DfareportingRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DfareportingRequest<PlacementGroupsListResponse>
  - setCallback
```
public Dfareporting.PlacementGroups.List setCallback(String callback)
```
    Description copied from class: DfareportingRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DfareportingRequest<PlacementGroupsListResponse>
  - setFields
```
public Dfareporting.PlacementGroups.List setFields(String fields)
```
    Description copied from class: DfareportingRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DfareportingRequest<PlacementGroupsListResponse>
  - setKey
```
public Dfareporting.PlacementGroups.List setKey(String key)
```
    Description copied from class: DfareportingRequest
    
    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.
    
    Overrides:
    
    setKey in class DfareportingRequest<PlacementGroupsListResponse>
  - setOauthToken
```
public Dfareporting.PlacementGroups.List setOauthToken(String oauthToken)
```
    Description copied from class: DfareportingRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DfareportingRequest<PlacementGroupsListResponse>
  - setPrettyPrint
```
public Dfareporting.PlacementGroups.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DfareportingRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DfareportingRequest<PlacementGroupsListResponse>
  - setQuotaUser
```
public Dfareporting.PlacementGroups.List setQuotaUser(String quotaUser)
```
    Description copied from class: DfareportingRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class DfareportingRequest<PlacementGroupsListResponse>
  - setUploadType
```
public Dfareporting.PlacementGroups.List setUploadType(String uploadType)
```
    Description copied from class: DfareportingRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DfareportingRequest<PlacementGroupsListResponse>
  - setUploadProtocol
```
public Dfareporting.PlacementGroups.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DfareportingRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DfareportingRequest<PlacementGroupsListResponse>
  - getProfileId
```
public Long getProfileId()
```
    User profile ID associated with this request.
  - setProfileId
```
public Dfareporting.PlacementGroups.List setProfileId(Long profileId)
```
    User profile ID associated with this request.
  - getActiveStatus
```
public List<String> getActiveStatus()
```
    Select only placements with these active statuses.
  - setActiveStatus
```
public Dfareporting.PlacementGroups.List setActiveStatus(List<String> activeStatus)
```
    Select only placements with these active statuses.
  - getAdvertiserIds
```
public List<Long> getAdvertiserIds()
```
    Select only placement groups that belong to these advertisers.
  - setAdvertiserIds
```
public Dfareporting.PlacementGroups.List setAdvertiserIds(List<Long> advertiserIds)
```
    Select only placement groups that belong to these advertisers.
  - getCampaignIds
```
public List<Long> getCampaignIds()
```
    Select only placement groups that belong to these campaigns.
  - setCampaignIds
```
public Dfareporting.PlacementGroups.List setCampaignIds(List<Long> campaignIds)
```
    Select only placement groups that belong to these campaigns.
  - getContentCategoryIds
```
public List<Long> getContentCategoryIds()
```
    Select only placement groups that are associated with these content categories.
  - setContentCategoryIds
```
public Dfareporting.PlacementGroups.List setContentCategoryIds(List<Long> contentCategoryIds)
```
    Select only placement groups that are associated with these content categories.
  - getDirectorySiteIds
```
public List<Long> getDirectorySiteIds()
```
    Select only placement groups that are associated with these directory sites.
  - setDirectorySiteIds
```
public Dfareporting.PlacementGroups.List setDirectorySiteIds(List<Long> directorySiteIds)
```
    Select only placement groups that are associated with these directory sites.
  - getIds
```
public List<Long> getIds()
```
    Select only placement groups with these IDs.
  - setIds
```
public Dfareporting.PlacementGroups.List setIds(List<Long> ids)
```
    Select only placement groups with these IDs.
  - getMaxEndDate
```
public String getMaxEndDate()
```
    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".
  - setMaxEndDate
```
public Dfareporting.PlacementGroups.List setMaxEndDate(String maxEndDate)
```
    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".
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of results to return. [default: 800]
  - setMaxResults
```
public Dfareporting.PlacementGroups.List setMaxResults(Integer maxResults)
```
    Maximum number of results to return.
  - getMaxStartDate
```
public String getMaxStartDate()
```
    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".
  - setMaxStartDate
```
public Dfareporting.PlacementGroups.List setMaxStartDate(String maxStartDate)
```
    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".
  - getMinEndDate
```
public String getMinEndDate()
```
    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".
  - setMinEndDate
```
public Dfareporting.PlacementGroups.List setMinEndDate(String minEndDate)
```
    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".
  - getMinStartDate
```
public String getMinStartDate()
```
    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".
  - setMinStartDate
```
public Dfareporting.PlacementGroups.List setMinStartDate(String minStartDate)
```
    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".
  - getPageToken
```
public String getPageToken()
```
    Value of the nextPageToken from the previous result page.
  - setPageToken
```
public Dfareporting.PlacementGroups.List setPageToken(String pageToken)
```
    Value of the nextPageToken from the previous result page.
  - getPlacementGroupType
```
public String getPlacementGroupType()
```
    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.
  - setPlacementGroupType
```
public Dfareporting.PlacementGroups.List setPlacementGroupType(String placementGroupType)
```
    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.
  - getPlacementStrategyIds
```
public List<Long> getPlacementStrategyIds()
```
    Select only placement groups that are associated with these placement strategies.
  - setPlacementStrategyIds
```
public Dfareporting.PlacementGroups.List setPlacementStrategyIds(List<Long> placementStrategyIds)
```
    Select only placement groups that are associated with these placement strategies.
  - getPricingTypes
```
public List<String> getPricingTypes()
```
    Select only placement groups with these pricing types.
  - setPricingTypes
```
public Dfareporting.PlacementGroups.List setPricingTypes(List<String> pricingTypes)
```
    Select only placement groups with these pricing types.
  - getSearchString
```
public String getSearchString()
```
    Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" 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".
  - setSearchString
```
public Dfareporting.PlacementGroups.List setSearchString(String searchString)
```
    Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" 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".
  - getSiteIds
```
public List<Long> getSiteIds()
```
    Select only placement groups that are associated with these sites.
  - setSiteIds
```
public Dfareporting.PlacementGroups.List setSiteIds(List<Long> siteIds)
```
    Select only placement groups that are associated with these sites.
  - getSortField
```
public String getSortField()
```
    Field by which to sort the list. [default: ID]
  - setSortField
```
public Dfareporting.PlacementGroups.List setSortField(String sortField)
```
    Field by which to sort the list.
  - getSortOrder
```
public String getSortOrder()
```
    Order of sorted results. [default: ASCENDING]
  - setSortOrder
```
public Dfareporting.PlacementGroups.List setSortOrder(String sortOrder)
```
    Order of sorted results.
  - set
```
public Dfareporting.PlacementGroups.List set(String parameterName,
                                             Object value)
```
    Overrides:
    
    set in class DfareportingRequest<PlacementGroupsListResponse>

Class Dfareporting.PlacementGroups.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.dfareporting.DfareportingRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getProfileId

setProfileId

getActiveStatus

setActiveStatus

getAdvertiserIds

setAdvertiserIds

getCampaignIds

setCampaignIds

getContentCategoryIds

setContentCategoryIds

getDirectorySiteIds

setDirectorySiteIds

getIds

setIds

getMaxEndDate

setMaxEndDate

getMaxResults

setMaxResults

getMaxStartDate

setMaxStartDate

getMinEndDate

setMinEndDate

getMinStartDate

setMinStartDate

getPageToken

setPageToken

getPlacementGroupType

setPlacementGroupType

getPlacementStrategyIds

setPlacementStrategyIds

getPricingTypes

setPricingTypes

getSearchString

setSearchString

getSiteIds

setSiteIds

getSortField

setSortField

getSortOrder

setSortOrder

set