Doubleclicksearch.Reports.GetIdMappingFile (Search Ads 360 API v2-rev20240124-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.doubleclicksearch.DoubleclicksearchRequest<IdMappingFile>
        
        com.google.api.services.doubleclicksearch.Doubleclicksearch.Reports.GetIdMappingFile

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

Enclosing class:: Doubleclicksearch.Reports

public class Doubleclicksearch.Reports.GetIdMappingFile
extends DoubleclicksearchRequest<IdMappingFile>

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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GetIdMappingFile(Long agencyId, Long advertiserId)` Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.GenericUrl`	`buildHttpRequestUrl()`
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeMedia()`
`void`	`executeMediaAndDownloadTo(OutputStream outputStream)`
`InputStream`	`executeMediaAsInputStream()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Long`	`getAdvertiserId()` Legacy SA360 advertiser ID.
`Long`	`getAgencyId()` Legacy SA360 agency ID.
`Doubleclicksearch.Reports.GetIdMappingFile`	`set(String parameterName, Object value)`
`Doubleclicksearch.Reports.GetIdMappingFile`	`set$Xgafv(String $Xgafv)` V1 error format.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setAccessToken(String accessToken)` OAuth access token.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setAdvertiserId(Long advertiserId)` Legacy SA360 advertiser ID.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setAgencyId(Long agencyId)` Legacy SA360 agency ID.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setAlt(String alt)` Data format for response.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setCallback(String callback)` JSONP
`Doubleclicksearch.Reports.GetIdMappingFile`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setKey(String key)` API key.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Doubleclicksearch.Reports.GetIdMappingFile`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.doubleclicksearch.DoubleclicksearchRequest
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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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
  - GetIdMappingFile
```
protected GetIdMappingFile(Long agencyId,
                           Long advertiserId)
```
    Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360. Create a request for the method "reports.getIdMappingFile". 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.
    GetIdMappingFile#initialize(com.google.api.client.googleapis.servi ces.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    agencyId - Legacy SA360 agency ID.
    
    advertiserId - Legacy SA360 advertiser ID.
    
    Since:
    
    1.13
- Method Detail
  - executeMediaAndDownloadTo
```
public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException
```
    Overrides:
    
    executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IdMappingFile>
    
    Throws:
    
    IOException
  - executeMediaAsInputStream
```
public InputStream executeMediaAsInputStream()
                                      throws IOException
```
    Overrides:
    
    executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IdMappingFile>
    
    Throws:
    
    IOException
  - executeMedia
```
public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws IOException
```
    Overrides:
    
    executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IdMappingFile>
    
    Throws:
    
    IOException
  - buildHttpRequestUrl
```
public com.google.api.client.http.GenericUrl buildHttpRequestUrl()
```
    Overrides:
    
    buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IdMappingFile>
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IdMappingFile>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<IdMappingFile>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Doubleclicksearch.Reports.GetIdMappingFile set$Xgafv(String $Xgafv)
```
    Description copied from class: DoubleclicksearchRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DoubleclicksearchRequest<IdMappingFile>
  - setAccessToken
```
public Doubleclicksearch.Reports.GetIdMappingFile setAccessToken(String accessToken)
```
    Description copied from class: DoubleclicksearchRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DoubleclicksearchRequest<IdMappingFile>
  - setAlt
```
public Doubleclicksearch.Reports.GetIdMappingFile setAlt(String alt)
```
    Description copied from class: DoubleclicksearchRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DoubleclicksearchRequest<IdMappingFile>
  - setCallback
```
public Doubleclicksearch.Reports.GetIdMappingFile setCallback(String callback)
```
    Description copied from class: DoubleclicksearchRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DoubleclicksearchRequest<IdMappingFile>
  - setFields
```
public Doubleclicksearch.Reports.GetIdMappingFile setFields(String fields)
```
    Description copied from class: DoubleclicksearchRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DoubleclicksearchRequest<IdMappingFile>
  - setKey
```
public Doubleclicksearch.Reports.GetIdMappingFile 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<IdMappingFile>
  - setOauthToken
```
public Doubleclicksearch.Reports.GetIdMappingFile setOauthToken(String oauthToken)
```
    Description copied from class: DoubleclicksearchRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DoubleclicksearchRequest<IdMappingFile>
  - setPrettyPrint
```
public Doubleclicksearch.Reports.GetIdMappingFile setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DoubleclicksearchRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DoubleclicksearchRequest<IdMappingFile>
  - setQuotaUser
```
public Doubleclicksearch.Reports.GetIdMappingFile setQuotaUser(String quotaUser)
```
    Description copied from class: DoubleclicksearchRequest
    
    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 DoubleclicksearchRequest<IdMappingFile>
  - setUploadType
```
public Doubleclicksearch.Reports.GetIdMappingFile setUploadType(String uploadType)
```
    Description copied from class: DoubleclicksearchRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DoubleclicksearchRequest<IdMappingFile>
  - setUploadProtocol
```
public Doubleclicksearch.Reports.GetIdMappingFile setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DoubleclicksearchRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DoubleclicksearchRequest<IdMappingFile>
  - getAgencyId
```
public Long getAgencyId()
```
    Legacy SA360 agency ID.
  - setAgencyId
```
public Doubleclicksearch.Reports.GetIdMappingFile setAgencyId(Long agencyId)
```
    Legacy SA360 agency ID.
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Legacy SA360 advertiser ID.
  - setAdvertiserId
```
public Doubleclicksearch.Reports.GetIdMappingFile setAdvertiserId(Long advertiserId)
```
    Legacy SA360 advertiser ID.
  - set
```
public Doubleclicksearch.Reports.GetIdMappingFile set(String parameterName,
                                                      Object value)
```
    Overrides:
    
    set in class DoubleclicksearchRequest<IdMappingFile>

Class Doubleclicksearch.Reports.GetIdMappingFile

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

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

GetIdMappingFile

Method Detail

executeMediaAndDownloadTo

executeMediaAsInputStream

executeMedia

buildHttpRequestUrl

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getAgencyId

setAgencyId

getAdvertiserId

setAdvertiserId

set