Wrapper class for the v13 Report service. This class is automatically generated.

Methods
D
G
N
S
V
Attributes
[R] api

Holds the AdWords::API object to which the wrapper belongs.

[R] module

Holds a shortcut to the parent module. Use this to avoid typing the full class name when creating classes belonging to this service, e.g. 

 service_object.module::ClassName

instead of 

 AdWords::V13::ReportService::ClassName

This will make it easier to migrate your code between API versions.

Class Public methods
new(driver, api)

Constructor for ReportServiceWrapper.

Args:

  • driver: SOAP::RPC::Driver object with the remote SOAP methods for this service
  • api: the AdWords::API object to which the wrapper belongs

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 34
        def initialize(driver, api)
          @driver = driver
          @api = api
          @module = AdWords::V13::ReportService
        end
Instance Public methods
deleteReport(reportJobId)

Calls the deleteReport method of the Report service. Check the online documentation for this method.

Args:

  • reportJobId: SOAP::SOAPLong

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 49
        def deleteReport(reportJobId)
          begin
            AdWords::Service.validate_param('reportJobId',
                reportJobId, SOAP::SOAPLong)
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::DeleteReport.new(reportJobId)
            return @driver.deleteReport(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "deleteReport Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
downloadCsvReport(job_id)

Extension method — Calls the AdWords::Extensions.downloadCsvReport method with self as the first parameter.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 212
        def downloadCsvReport(job_id)
          return AdWords::Extensions.downloadCsvReport(self, job_id)
        end
downloadXmlReport(job_id)

Extension method — Calls the AdWords::Extensions.downloadXmlReport method with self as the first parameter.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 206
        def downloadXmlReport(job_id)
          return AdWords::Extensions.downloadXmlReport(self, job_id)
        end
getAllJobs()

Calls the getAllJobs method of the Report service. Check the online documentation for this method.

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 71
        def getAllJobs()
          begin
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::GetAllJobs.new()
            return @driver.getAllJobs(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "getAllJobs Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
getGzipReportDownloadUrl(reportJobId)

Calls the getGzipReportDownloadUrl method of the Report service. Check the online documentation for this method.

Args:

  • reportJobId: SOAP::SOAPLong

Returns:

  • getGzipReportDownloadUrlReturn: SOAP::SOAPString

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 94
        def getGzipReportDownloadUrl(reportJobId)
          begin
            AdWords::Service.validate_param('reportJobId',
                reportJobId, SOAP::SOAPLong)
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::GetGzipReportDownloadUrl.new(reportJobId)
            return @driver.getGzipReportDownloadUrl(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "getGzipReportDownloadUrl Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
getReportDownloadUrl(reportJobId)

Calls the getReportDownloadUrl method of the Report service. Check the online documentation for this method.

Args:

  • reportJobId: SOAP::SOAPLong

Returns:

  • getReportDownloadUrlReturn: SOAP::SOAPString

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 119
        def getReportDownloadUrl(reportJobId)
          begin
            AdWords::Service.validate_param('reportJobId',
                reportJobId, SOAP::SOAPLong)
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::GetReportDownloadUrl.new(reportJobId)
            return @driver.getReportDownloadUrl(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "getReportDownloadUrl Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
getReportJobStatus(reportJobId)

Calls the getReportJobStatus method of the Report service. Check the online documentation for this method.

Args:

  • reportJobId: SOAP::SOAPLong

Returns:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 144
        def getReportJobStatus(reportJobId)
          begin
            AdWords::Service.validate_param('reportJobId',
                reportJobId, SOAP::SOAPLong)
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::GetReportJobStatus.new(reportJobId)
            return @driver.getReportJobStatus(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "getReportJobStatus Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
scheduleReportJob(job)

Calls the scheduleReportJob method of the Report service. Check the online documentation for this method.

Args:

Returns:

  • scheduleReportJobReturn: SOAP::SOAPLong

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 169
        def scheduleReportJob(job)
          begin
            AdWords::Service.validate_param('job',
                job, AdWords::V13::ReportService::ReportJob)
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::ScheduleReportJob.new(job)
            return @driver.scheduleReportJob(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "scheduleReportJob Call Failed: " + fault.faultstring.to_s, caller)
          end
        end
validateReportJob(job)

Calls the validateReportJob method of the Report service. Check the online documentation for this method.

Args:

Raises: Error::ApiError (or a subclass thereof) if a SOAP fault occurs.

Source: show 

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 191
        def validateReportJob(job)
          begin
            AdWords::Service.validate_param('job',
                job, AdWords::V13::ReportService::ReportJob)
            # Construct request object and make API call
            obj = AdWords::V13::ReportService::ValidateReportJob.new(job)
            return @driver.validateReportJob(obj)
          rescue SOAP::FaultError => fault
            raise(AdWords::Error::create_specific_api_error(fault),
                "validateReportJob Call Failed: " + fault.faultstring.to_s, caller)
          end
        end