com.google.api.services.doubleclicksearch

Class Doubleclicksearch.Conversion.Get

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.doubleclicksearch.DoubleclicksearchRequest<ConversionList>

com.google.api.services.doubleclicksearch.Doubleclicksearch.Conversion.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Doubleclicksearch.Conversion

public class Doubleclicksearch.Conversion.Get
extends DoubleclicksearchRequest<ConversionList>

Nested Class Summary

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Get(Long agencyId, Long advertiserId, Long engineAccountId, Integer endDate, Integer rowCount, Integer startDate, Long startRow) Retrieves a list of conversions from a DoubleClick Search engine account.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Long	getAdGroupId() Numeric ID of the ad group.
Long	getAdId() Numeric ID of the ad.
Long	getAdvertiserId() Numeric ID of the advertiser.
Long	getAgencyId() Numeric ID of the agency.
Long	getCampaignId() Numeric ID of the campaign.
Long	getCriterionId() Numeric ID of the criterion.
Integer	getEndDate() Last date (inclusive) on which to retrieve conversions.
Long	getEngineAccountId() Numeric ID of the engine account.
Integer	getRowCount() The number of conversions to return per call.
Integer	getStartDate() First date (inclusive) on which to retrieve conversions.
Long	getStartRow() The 0-based starting index for retrieving conversions results.
Doubleclicksearch.Conversion.Get	set(String parameterName, Object value)
Doubleclicksearch.Conversion.Get	setAdGroupId(Long adGroupId) Numeric ID of the ad group.
Doubleclicksearch.Conversion.Get	setAdId(Long adId) Numeric ID of the ad.
Doubleclicksearch.Conversion.Get	setAdvertiserId(Long advertiserId) Numeric ID of the advertiser.
Doubleclicksearch.Conversion.Get	setAgencyId(Long agencyId) Numeric ID of the agency.
Doubleclicksearch.Conversion.Get	setAlt(String alt) Data format for the response.
Doubleclicksearch.Conversion.Get	setCampaignId(Long campaignId) Numeric ID of the campaign.
Doubleclicksearch.Conversion.Get	setCriterionId(Long criterionId) Numeric ID of the criterion.
Doubleclicksearch.Conversion.Get	setEndDate(Integer endDate) Last date (inclusive) on which to retrieve conversions.
Doubleclicksearch.Conversion.Get	setEngineAccountId(Long engineAccountId) Numeric ID of the engine account.
Doubleclicksearch.Conversion.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Doubleclicksearch.Conversion.Get	setKey(String key) API key.
Doubleclicksearch.Conversion.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Doubleclicksearch.Conversion.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Doubleclicksearch.Conversion.Get	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Doubleclicksearch.Conversion.Get	setRowCount(Integer rowCount) The number of conversions to return per call.
Doubleclicksearch.Conversion.Get	setStartDate(Integer startDate) First date (inclusive) on which to retrieve conversions.
Doubleclicksearch.Conversion.Get	setStartRow(Long startRow) The 0-based starting index for retrieving conversions results.
Doubleclicksearch.Conversion.Get	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.doubleclicksearch.DoubleclicksearchRequest

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Get

protected Get(Long agencyId,
              Long advertiserId,
              Long engineAccountId,
              Integer endDate,
              Integer rowCount,
              Integer startDate,
              Long startRow)

Retrieves a list of conversions from a DoubleClick Search engine account. Create a request for the method "conversion.get". This request holds the parameters needed by the the doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Doubleclicksearch.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

agencyId - Numeric ID of the agency.

advertiserId - Numeric ID of the advertiser.

engineAccountId - Numeric ID of the engine account.

endDate - Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. [minimum: 20091101] [maximum: 99991231]

rowCount - The number of conversions to return per call. [minimum: 1] [maximum: 1000]

startDate - First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. [minimum: 20091101] [maximum: 99991231]

startRow - The 0-based starting index for retrieving conversions results.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ConversionList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ConversionList>

Throws:

IOException

setAlt

public Doubleclicksearch.Conversion.Get setAlt(String alt)

Description copied from class: DoubleclicksearchRequest

Data format for the response.

Overrides:

setAlt in class DoubleclicksearchRequest<ConversionList>

setFields

public Doubleclicksearch.Conversion.Get setFields(String fields)

Description copied from class: DoubleclicksearchRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DoubleclicksearchRequest<ConversionList>

setKey

public Doubleclicksearch.Conversion.Get setKey(String key)

Description copied from class: DoubleclicksearchRequest

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 DoubleclicksearchRequest<ConversionList>

setOauthToken

public Doubleclicksearch.Conversion.Get setOauthToken(String oauthToken)

Description copied from class: DoubleclicksearchRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DoubleclicksearchRequest<ConversionList>

setPrettyPrint

public Doubleclicksearch.Conversion.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DoubleclicksearchRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DoubleclicksearchRequest<ConversionList>

setQuotaUser

public Doubleclicksearch.Conversion.Get setQuotaUser(String quotaUser)

Description copied from class: DoubleclicksearchRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DoubleclicksearchRequest<ConversionList>

setUserIp

public Doubleclicksearch.Conversion.Get setUserIp(String userIp)

Description copied from class: DoubleclicksearchRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DoubleclicksearchRequest<ConversionList>

getAgencyId

public Long getAgencyId()

Numeric ID of the agency.

setAgencyId

public Doubleclicksearch.Conversion.Get setAgencyId(Long agencyId)

Numeric ID of the agency.

getAdvertiserId

public Long getAdvertiserId()

Numeric ID of the advertiser.

setAdvertiserId

public Doubleclicksearch.Conversion.Get setAdvertiserId(Long advertiserId)

Numeric ID of the advertiser.

getEngineAccountId

public Long getEngineAccountId()

Numeric ID of the engine account.

setEngineAccountId

public Doubleclicksearch.Conversion.Get setEngineAccountId(Long engineAccountId)

Numeric ID of the engine account.

getEndDate

public Integer getEndDate()

Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. [minimum: 20091101] [maximum: 99991231]

setEndDate

public Doubleclicksearch.Conversion.Get setEndDate(Integer endDate)

Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.

getRowCount

public Integer getRowCount()

The number of conversions to return per call. [minimum: 1] [maximum: 1000]

setRowCount

public Doubleclicksearch.Conversion.Get setRowCount(Integer rowCount)

The number of conversions to return per call.

getStartDate

public Integer getStartDate()

First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. [minimum: 20091101] [maximum: 99991231]

setStartDate

public Doubleclicksearch.Conversion.Get setStartDate(Integer startDate)

First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.

getStartRow

public Long getStartRow()

The 0-based starting index for retrieving conversions results.

setStartRow

public Doubleclicksearch.Conversion.Get setStartRow(Long startRow)

The 0-based starting index for retrieving conversions results.

getAdGroupId

public Long getAdGroupId()

Numeric ID of the ad group.

setAdGroupId

public Doubleclicksearch.Conversion.Get setAdGroupId(Long adGroupId)

Numeric ID of the ad group.

getAdId

public Long getAdId()

Numeric ID of the ad.

setAdId

public Doubleclicksearch.Conversion.Get setAdId(Long adId)

Numeric ID of the ad.

getCampaignId

public Long getCampaignId()

Numeric ID of the campaign.

setCampaignId

public Doubleclicksearch.Conversion.Get setCampaignId(Long campaignId)

Numeric ID of the campaign.

getCriterionId

public Long getCriterionId()

Numeric ID of the criterion.

setCriterionId

public Doubleclicksearch.Conversion.Get setCriterionId(Long criterionId)

Numeric ID of the criterion.

set

public Doubleclicksearch.Conversion.Get set(String parameterName,
                                            Object value)

Overrides:

set in class DoubleclicksearchRequest<ConversionList>