com.google.api.services.dfareporting

Class Dfareporting.PlacementGroups.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Dfareporting.PlacementGroups.List(java.lang.Long profileId) Retrieves a list of placement groups, possibly filtered.

Method Summary

Methods

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

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dfareporting.PlacementGroups.List

protected Dfareporting.PlacementGroups.List(java.lang.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 java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlacementGroupsListResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PlacementGroupsListResponse>

Throws:

java.io.IOException

setAlt

public Dfareporting.PlacementGroups.List setAlt(java.lang.String alt)

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<PlacementGroupsListResponse>

setFields

public Dfareporting.PlacementGroups.List setFields(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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 userIp if both are provided.

Overrides:

setQuotaUser in class DfareportingRequest<PlacementGroupsListResponse>

setUserIp

public Dfareporting.PlacementGroups.List setUserIp(java.lang.String userIp)

Description copied from class: DfareportingRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DfareportingRequest<PlacementGroupsListResponse>

getProfileId

public java.lang.Long getProfileId()

User profile ID associated with this request.

setProfileId

public Dfareporting.PlacementGroups.List setProfileId(java.lang.Long profileId)

User profile ID associated with this request.

getAdvertiserIds

public java.util.List<java.lang.Long> getAdvertiserIds()

Select only placement groups that belong to these advertisers.

setAdvertiserIds

public Dfareporting.PlacementGroups.List setAdvertiserIds(java.util.List<java.lang.Long> advertiserIds)

Select only placement groups that belong to these advertisers.

getArchived

public java.lang.Boolean getArchived()

Select only archived placements. Don't set this field to select both archived and non-archived placements.

setArchived

public Dfareporting.PlacementGroups.List setArchived(java.lang.Boolean archived)

Select only archived placements. Don't set this field to select both archived and non- archived placements.

getCampaignIds

public java.util.List<java.lang.Long> getCampaignIds()

Select only placement groups that belong to these campaigns.

setCampaignIds

public Dfareporting.PlacementGroups.List setCampaignIds(java.util.List<java.lang.Long> campaignIds)

Select only placement groups that belong to these campaigns.

getContentCategoryIds

public java.util.List<java.lang.Long> getContentCategoryIds()

Select only placement groups that are associated with these content categories.

setContentCategoryIds

public Dfareporting.PlacementGroups.List setContentCategoryIds(java.util.List<java.lang.Long> contentCategoryIds)

Select only placement groups that are associated with these content categories.

getDirectorySiteIds

public java.util.List<java.lang.Long> getDirectorySiteIds()

Select only placement groups that are associated with these directory sites.

setDirectorySiteIds

public Dfareporting.PlacementGroups.List setDirectorySiteIds(java.util.List<java.lang.Long> directorySiteIds)

Select only placement groups that are associated with these directory sites.

getIds

public java.util.List<java.lang.Long> getIds()

Select only placement groups with these IDs.

setIds

public Dfareporting.PlacementGroups.List setIds(java.util.List<java.lang.Long> ids)

Select only placement groups with these IDs.

getMaxEndDate

public java.lang.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(java.lang.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 java.lang.Integer getMaxResults()

Maximum number of results to return. [default: 800] [minimum: 0] [maximum: 800]

setMaxResults

public Dfareporting.PlacementGroups.List setMaxResults(java.lang.Integer maxResults)

Maximum number of results to return.

getMaxStartDate

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

public Dfareporting.PlacementGroups.List setPageToken(java.lang.String pageToken)

Value of the nextPageToken from the previous result page.

getPlacementGroupType

public java.lang.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(java.lang.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 java.util.List<java.lang.Long> getPlacementStrategyIds()

Select only placement groups that are associated with these placement strategies.

setPlacementStrategyIds

public Dfareporting.PlacementGroups.List setPlacementStrategyIds(java.util.List<java.lang.Long> placementStrategyIds)

Select only placement groups that are associated with these placement strategies.

getPricingTypes

public java.util.List<java.lang.String> getPricingTypes()

Select only placement groups with these pricing types.

setPricingTypes

public Dfareporting.PlacementGroups.List setPricingTypes(java.util.List<java.lang.String> pricingTypes)

Select only placement groups with these pricing types.

getSearchString

public java.lang.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(java.lang.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 java.util.List<java.lang.Long> getSiteIds()

Select only placement groups that are associated with these sites.

setSiteIds

public Dfareporting.PlacementGroups.List setSiteIds(java.util.List<java.lang.Long> siteIds)

Select only placement groups that are associated with these sites.

getSortField

public java.lang.String getSortField()

Field by which to sort the list. [default: ID]

setSortField

public Dfareporting.PlacementGroups.List setSortField(java.lang.String sortField)

Field by which to sort the list.

getSortOrder

public java.lang.String getSortOrder()

Order of sorted results. [default: ASCENDING]

setSortOrder

public Dfareporting.PlacementGroups.List setSortOrder(java.lang.String sortOrder)

Order of sorted results.

set

public Dfareporting.PlacementGroups.List set(java.lang.String parameterName,
                                    java.lang.Object value)

Overrides:

set in class DfareportingRequest<PlacementGroupsListResponse>