com.google.api.services.doubleclicksearch

Class Doubleclicksearch.Reports

java.lang.Object

com.google.api.services.doubleclicksearch.Doubleclicksearch.Reports

Enclosing class:

Doubleclicksearch

public class Doubleclicksearch.Reports
extends Object

The "reports" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Doubleclicksearch.Reports.Generate
class	Doubleclicksearch.Reports.Get
class	Doubleclicksearch.Reports.GetFile
class	Doubleclicksearch.Reports.GetIdMappingFile
class	Doubleclicksearch.Reports.Request

Constructor Summary

Constructors

Constructor and Description
Reports()

Method Summary

Modifier and Type	Method and Description
Doubleclicksearch.Reports.Generate	generate(ReportRequest content) Generates and returns a report immediately.
Doubleclicksearch.Reports.Get	get(String reportId) Polls for the status of a report request.
Doubleclicksearch.Reports.GetFile	getFile(String reportId, Integer reportFragment) Downloads a report file encoded in UTF-8.
Doubleclicksearch.Reports.GetIdMappingFile	getIdMappingFile(Long agencyId, Long advertiserId) Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360.
Doubleclicksearch.Reports.Request	request(ReportRequest content) Inserts a report request into the reporting system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Reports

public Reports()

Method Detail

generate

public Doubleclicksearch.Reports.Generate generate(ReportRequest content)
                                            throws IOException

Generates and returns a report immediately. Create a request for the method "reports.generate". This request holds the parameters needed by the doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the ReportRequest

Returns:

the request

Throws:

IOException

get

public Doubleclicksearch.Reports.Get get(String reportId)
                                  throws IOException

Polls for the status of a report request. Create a request for the method "reports.get". This request holds the parameters needed by the doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

reportId - ID of the report request being polled.

Returns:

the request

Throws:

IOException

getFile

public Doubleclicksearch.Reports.GetFile getFile(String reportId,
                                                 Integer reportFragment)
                                          throws IOException

Downloads a report file encoded in UTF-8. Create a request for the method "reports.getFile". This request holds the parameters needed by the doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

reportId - ID of the report.

reportFragment - The index of the report fragment to download. [minimum: 0]

Returns:

the request

Throws:

IOException

getIdMappingFile

public Doubleclicksearch.Reports.GetIdMappingFile getIdMappingFile(Long agencyId,
                                                                   Long advertiserId)
                                                            throws IOException

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 doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

agencyId - Legacy SA360 agency ID.

advertiserId - Legacy SA360 advertiser ID.

Returns:

the request

Throws:

IOException

request

public Doubleclicksearch.Reports.Request request(ReportRequest content)
                                          throws IOException

Inserts a report request into the reporting system. Create a request for the method "reports.request". This request holds the parameters needed by the doubleclicksearch server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the ReportRequest

Returns:

the request

Throws:

IOException