com.google.api.services.dfareporting

Class Dfareporting.Ads.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<AdsListResponse>

com.google.api.services.dfareporting.Dfareporting.Ads.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Dfareporting.Ads

public class Dfareporting.Ads.List
extends DfareportingRequest<AdsListResponse>

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.Ads.List(java.lang.Long profileId) Retrieves a list of ads, 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.lang.Boolean	getActive() Select only active ads.
java.lang.Long	getAdvertiserId() Select only ads with this advertiser ID.
java.lang.Boolean	getArchived() Select only archived ads.
java.util.List<java.lang.Long>	getAudienceSegmentIds() Select only ads with these audience segment IDs.
java.util.List<java.lang.Long>	getCampaignIds() Select only ads with these campaign IDs.
java.lang.String	getCompatibility() Select default ads with the specified compatibility.
java.util.List<java.lang.Long>	getCreativeIds() Select only ads with these creative IDs assigned.
java.util.List<java.lang.Long>	getCreativeOptimizationConfigurationIds() Select only ads with these creative optimization configuration IDs.
java.lang.Boolean	getDynamicClickTracker() Select only dynamic click trackers.
java.util.List<java.lang.Long>	getIds() Select only ads with these IDs.
java.util.List<java.lang.Long>	getLandingPageIds() Select only ads with these landing page IDs.
java.lang.Integer	getMaxResults() Maximum number of results to return.
java.lang.Long	getOverriddenEventTagId() Select only ads with this event tag override ID.
java.lang.String	getPageToken() Value of the nextPageToken from the previous result page.
java.util.List<java.lang.Long>	getPlacementIds() Select only ads with these placement IDs assigned.
java.lang.Long	getProfileId() User profile ID associated with this request.
java.util.List<java.lang.Long>	getRemarketingListIds() Select only ads whose list targeting expression use these remarketing list IDs.
java.lang.String	getSearchString() Allows searching for objects by name or ID.
java.util.List<java.lang.Long>	getSizeIds() Select only ads with these size IDs.
java.lang.String	getSortField() Field by which to sort the list.
java.lang.String	getSortOrder() Order of sorted results.
java.lang.Boolean	getSslCompliant() Select only ads that are SSL-compliant.
java.lang.Boolean	getSslRequired() Select only ads that require SSL.
java.util.List<java.lang.String>	getType() Select only ads with these types.
Dfareporting.Ads.List	set(java.lang.String parameterName, java.lang.Object value)
Dfareporting.Ads.List	setActive(java.lang.Boolean active) Select only active ads.
Dfareporting.Ads.List	setAdvertiserId(java.lang.Long advertiserId) Select only ads with this advertiser ID.
Dfareporting.Ads.List	setAlt(java.lang.String alt) Data format for the response.
Dfareporting.Ads.List	setArchived(java.lang.Boolean archived) Select only archived ads.
Dfareporting.Ads.List	setAudienceSegmentIds(java.util.List<java.lang.Long> audienceSegmentIds) Select only ads with these audience segment IDs.
Dfareporting.Ads.List	setCampaignIds(java.util.List<java.lang.Long> campaignIds) Select only ads with these campaign IDs.
Dfareporting.Ads.List	setCompatibility(java.lang.String compatibility) Select default ads with the specified compatibility.
Dfareporting.Ads.List	setCreativeIds(java.util.List<java.lang.Long> creativeIds) Select only ads with these creative IDs assigned.
Dfareporting.Ads.List	setCreativeOptimizationConfigurationIds(java.util.List<java.lang.Long> creativeOptimizationConfigurationIds) Select only ads with these creative optimization configuration IDs.
Dfareporting.Ads.List	setDynamicClickTracker(java.lang.Boolean dynamicClickTracker) Select only dynamic click trackers.
Dfareporting.Ads.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Dfareporting.Ads.List	setIds(java.util.List<java.lang.Long> ids) Select only ads with these IDs.
Dfareporting.Ads.List	setKey(java.lang.String key) API key.
Dfareporting.Ads.List	setLandingPageIds(java.util.List<java.lang.Long> landingPageIds) Select only ads with these landing page IDs.
Dfareporting.Ads.List	setMaxResults(java.lang.Integer maxResults) Maximum number of results to return.
Dfareporting.Ads.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Dfareporting.Ads.List	setOverriddenEventTagId(java.lang.Long overriddenEventTagId) Select only ads with this event tag override ID.
Dfareporting.Ads.List	setPageToken(java.lang.String pageToken) Value of the nextPageToken from the previous result page.
Dfareporting.Ads.List	setPlacementIds(java.util.List<java.lang.Long> placementIds) Select only ads with these placement IDs assigned.
Dfareporting.Ads.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Dfareporting.Ads.List	setProfileId(java.lang.Long profileId) User profile ID associated with this request.
Dfareporting.Ads.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Dfareporting.Ads.List	setRemarketingListIds(java.util.List<java.lang.Long> remarketingListIds) Select only ads whose list targeting expression use these remarketing list IDs.
Dfareporting.Ads.List	setSearchString(java.lang.String searchString) Allows searching for objects by name or ID.
Dfareporting.Ads.List	setSizeIds(java.util.List<java.lang.Long> sizeIds) Select only ads with these size IDs.
Dfareporting.Ads.List	setSortField(java.lang.String sortField) Field by which to sort the list.
Dfareporting.Ads.List	setSortOrder(java.lang.String sortOrder) Order of sorted results.
Dfareporting.Ads.List	setSslCompliant(java.lang.Boolean sslCompliant) Select only ads that are SSL-compliant.
Dfareporting.Ads.List	setSslRequired(java.lang.Boolean sslRequired) Select only ads that require SSL.
Dfareporting.Ads.List	setType(java.util.List<java.lang.String> type) Select only ads with these types.
Dfareporting.Ads.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.Ads.List

protected Dfareporting.Ads.List(java.lang.Long profileId)

Retrieves a list of ads, possibly filtered. This method supports paging. Create a request for the method "ads.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<AdsListResponse>

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<AdsListResponse>

Throws:

java.io.IOException

setAlt

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

Description copied from class: DfareportingRequest

Data format for the response.

Overrides:

setAlt in class DfareportingRequest<AdsListResponse>

setFields

public Dfareporting.Ads.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<AdsListResponse>

setKey

public Dfareporting.Ads.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<AdsListResponse>

setOauthToken

public Dfareporting.Ads.List setOauthToken(java.lang.String oauthToken)

Description copied from class: DfareportingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DfareportingRequest<AdsListResponse>

setPrettyPrint

public Dfareporting.Ads.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DfareportingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DfareportingRequest<AdsListResponse>

setQuotaUser

public Dfareporting.Ads.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<AdsListResponse>

setUserIp

public Dfareporting.Ads.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<AdsListResponse>

getProfileId

public java.lang.Long getProfileId()

User profile ID associated with this request.

setProfileId

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

User profile ID associated with this request.

getActive

public java.lang.Boolean getActive()

Select only active ads.

setActive

public Dfareporting.Ads.List setActive(java.lang.Boolean active)

Select only active ads.

getAdvertiserId

public java.lang.Long getAdvertiserId()

Select only ads with this advertiser ID.

setAdvertiserId

public Dfareporting.Ads.List setAdvertiserId(java.lang.Long advertiserId)

Select only ads with this advertiser ID.

getArchived

public java.lang.Boolean getArchived()

Select only archived ads.

setArchived

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

Select only archived ads.

getAudienceSegmentIds

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

Select only ads with these audience segment IDs.

setAudienceSegmentIds

public Dfareporting.Ads.List setAudienceSegmentIds(java.util.List<java.lang.Long> audienceSegmentIds)

Select only ads with these audience segment IDs.

getCampaignIds

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

Select only ads with these campaign IDs.

setCampaignIds

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

Select only ads with these campaign IDs.

getCompatibility

public java.lang.String getCompatibility()

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. 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 an in-stream video ads developed with the VAST standard.

setCompatibility

public Dfareporting.Ads.List setCompatibility(java.lang.String compatibility)

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. 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 an in-stream video ads developed with the VAST standard.

getCreativeIds

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

Select only ads with these creative IDs assigned.

setCreativeIds

public Dfareporting.Ads.List setCreativeIds(java.util.List<java.lang.Long> creativeIds)

Select only ads with these creative IDs assigned.

getCreativeOptimizationConfigurationIds

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

Select only ads with these creative optimization configuration IDs.

setCreativeOptimizationConfigurationIds

public Dfareporting.Ads.List setCreativeOptimizationConfigurationIds(java.util.List<java.lang.Long> creativeOptimizationConfigurationIds)

Select only ads with these creative optimization configuration IDs.

getDynamicClickTracker

public java.lang.Boolean getDynamicClickTracker()

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

setDynamicClickTracker

public Dfareporting.Ads.List setDynamicClickTracker(java.lang.Boolean dynamicClickTracker)

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

getIds

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

Select only ads with these IDs.

setIds

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

Select only ads with these IDs.

getLandingPageIds

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

Select only ads with these landing page IDs.

setLandingPageIds

public Dfareporting.Ads.List setLandingPageIds(java.util.List<java.lang.Long> landingPageIds)

Select only ads with these landing page IDs.

getMaxResults

public java.lang.Integer getMaxResults()

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

setMaxResults

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

Maximum number of results to return.

getOverriddenEventTagId

public java.lang.Long getOverriddenEventTagId()

Select only ads with this event tag override ID.

setOverriddenEventTagId

public Dfareporting.Ads.List setOverriddenEventTagId(java.lang.Long overriddenEventTagId)

Select only ads with this event tag override ID.

getPageToken

public java.lang.String getPageToken()

Value of the nextPageToken from the previous result page.

setPageToken

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

Value of the nextPageToken from the previous result page.

getPlacementIds

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

Select only ads with these placement IDs assigned.

setPlacementIds

public Dfareporting.Ads.List setPlacementIds(java.util.List<java.lang.Long> placementIds)

Select only ads with these placement IDs assigned.

getRemarketingListIds

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

Select only ads whose list targeting expression use these remarketing list IDs.

setRemarketingListIds

public Dfareporting.Ads.List setRemarketingListIds(java.util.List<java.lang.Long> remarketingListIds)

Select only ads whose list targeting expression use these remarketing list IDs.

getSearchString

public java.lang.String getSearchString()

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".

setSearchString

public Dfareporting.Ads.List setSearchString(java.lang.String searchString)

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 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 "ad" will match objects with name "my ad", "ad 2015", or simply "ad".

getSizeIds

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

Select only ads with these size IDs.

setSizeIds

public Dfareporting.Ads.List setSizeIds(java.util.List<java.lang.Long> sizeIds)

Select only ads with these size IDs.

getSortField

public java.lang.String getSortField()

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

setSortField

public Dfareporting.Ads.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.Ads.List setSortOrder(java.lang.String sortOrder)

Order of sorted results.

getSslCompliant

public java.lang.Boolean getSslCompliant()

Select only ads that are SSL-compliant.

setSslCompliant

public Dfareporting.Ads.List setSslCompliant(java.lang.Boolean sslCompliant)

Select only ads that are SSL-compliant.

getSslRequired

public java.lang.Boolean getSslRequired()

Select only ads that require SSL.

setSslRequired

public Dfareporting.Ads.List setSslRequired(java.lang.Boolean sslRequired)

Select only ads that require SSL.

getType

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

Select only ads with these types.

setType

public Dfareporting.Ads.List setType(java.util.List<java.lang.String> type)

Select only ads with these types.

set

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

Overrides:

set in class DfareportingRequest<AdsListResponse>