AdWords::V13::ReportService::ReportServiceWrapper

new(driver, api)

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 25
        def initialize(driver, api)
          @driver = driver
          @api = api
        end

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 39
        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 202
        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 196
        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:

getAllJobsReturn: SOAP::SOAPArray of AdWords::V13::ReportService::ReportJob

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

Source: show

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 61
        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 84
        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 109
        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:

getReportJobStatusReturn: AdWords::V13::ReportService::ReportJobStatus

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

Source: show

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 134
        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:

job: AdWords::V13::ReportService::ReportJob

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 159
        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:

job: AdWords::V13::ReportService::ReportJob

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

Source: show

# File lib/adwords4r/v13/ReportServiceWrapper.rb, line 181
        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

Class AdWords::V13::ReportService::ReportServiceWrapper < Object