Docs For Class AdWordReportService

AdWordReportService

Description

AdWords Lib Report Service Class

Report Service provides operations for getting reports about your AdWords account

copyright: Mirchev Ideas Ltd. © 2003, 2004, 2005
link: http://www.google.com/apis/adwords/developer/ReportService.html For more information about ReportService see in Google AdWords Developer's Guide

Located in /services/AdWordReportService.inc

AdWordService
   |
   --AdWordReportService

Method Summary

AdWordReportService AdWordReportService (string $soapToolkit)

bool deleteReport (int $reportJobId, [string $clientEmail = ''])

array|false getAllJobs ([string $clientEmail = ''])

string|false getGzipReportDownloadUrl (int $reportJobId, [string $clientEmail = ''])

string|false getReportDownloadUrl (int $reportJobId, [string $clientEmail = ''])

string|false getReportJobStatus (int $reportJobId, [string $clientEmail = ''])

int|false scheduleReportJob (object AdWordReportJob $job, [string $clientEmail = ''])

Methods

AdWordReportService Constructor. It takes one parameter - name of a supported by AdWords Lib SOAP toolkit

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordReportService AdWordReportService (string $soapToolkit)

string $soapToolkit: name of a supported by AdWords Lib SOAP Toolkit

Deletes a report job along with the report it produced, if any.

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $reportService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$reportJobId - ID of the ReportJob
 $response = $reportService->deleteReport($reportJobId);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response == true
 ?>

return: true on success, or false on error
link: http://www.google.com/apis/adwords/developer/ReportService.html#deleteReport For more information about deleteReport see in Google AdWords Developer's Guide

bool deleteReport (int $reportJobId, [string $clientEmail = ''])

int $reportJobId: ID of the ReportJob
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns an array consisting of all jobs the user has scheduled

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $reportService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $reportService->getAllJobs();
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is an array of objects of class AdWordReportJob
 ?>

return: array of objects of class AdWordReportJob or false on error
see: AdWordReportJob
link: http://www.google.com/apis/adwords/developer/ReportService.html#getAllJobs For more information about getAllJobs see in Google AdWords Developer's Guide

array|false getAllJobs ([string $clientEmail = ''])

string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns a URL from which the report with the given job ID can be downloaded (in Gzip format)

After invoking this method, the caller can do a regular HTTP GET on the returned URL to retrieve the report.

NOTE: To extract the gzip archive use: $xmlFile=gzinflate(substr($downloadedFile,10));

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $reportService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$reportJobId - ID of the ReportJob
 $response = $reportService->getGzipReportDownloadUrl($reportJobId);
 if ($response === false) { // if an error appears
         $errr = $reportService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response  - A URL from which the compressed report can be downloaded.
 ?>

return: URL from which the report can be downloaded, or false on error
link: http://www.google.com/apis/adwords/developer/ReportService.html#getGzipReportDownloadUrl For more information about getGzipReportDownloadUrl see in Google AdWords Developer's Guide

string|false getGzipReportDownloadUrl (int $reportJobId, [string $clientEmail = ''])

int $reportJobId: ID of the ReportJob
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns a URL from which the report with the given job ID can be downloaded

After invoking this method, the caller can do a regular HTTP GET on the returned URL to retrieve the report.

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $reportService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$reportJobId - ID of the ReportJob
 $response = $reportService->getReportDownloadUrl($reportJobId);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response  - URL from which the report can be downloaded
 ?>

return: URL from which the report can be downloaded, or false on error
link: http://www.google.com/apis/adwords/developer/ReportService.html#getReportDownloadUrl For more information about getReportDownloadUrl see in Google AdWords Developer's Guide

string|false getReportDownloadUrl (int $reportJobId, [string $clientEmail = ''])

int $reportJobId: ID of the ReportJob
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Returns the status of the report job with the given reportJobId

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $reportService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$reportJobId - ID of the ReportJob
 $response = $reportService->getReportJobStatus($reportJobId);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response  - The report job status
 ?>

return: the report job status, or false on error
link: http://www.google.com/apis/adwords/developer/ReportService.html#getReportJobStatus For more information about getReportJobStatus see in Google AdWords Developer's Guide

string|false getReportJobStatus (int $reportJobId, [string $clientEmail = ''])

int $reportJobId: ID of the ReportJob
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Schedules a report job for execution

Example:

 <?php
 $reportService = new AdWordReportService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $reportService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 //$reportJ is an object of class AdWordReportJob
 $response = $reportService->scheduleReportJob($reportJ);
 if ($response === false) { // if an error appears
         $errr = $classKW->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response - a handle to the scheduled report job
 ?>

return: a handle to the scheduled report job, or false on error
see: AdWordReportJob
link: http://www.google.com/apis/adwords/developer/ReportService.html#scheduleReportJob For more information about scheduleReportJob see in Google AdWords Developer's Guide

int|false scheduleReportJob (object AdWordReportJob $job, [string $clientEmail = ''])

object AdWordReportJob $job: object of class AdWordReportJob
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Inherited Methods

Inherited From AdWordService

AdWordService::AdWordService()
AdWordService::callService()
AdWordService::getAccount()
AdWordService::getClientCustomerId()
AdWordService::getClientEmail()
AdWordService::getLastError()
AdWordService::getResponseHeaders()
AdWordService::setAccount()
AdWordService::setClientCustomerId()
AdWordService::setClientEmail()

Documentation generated on Mon, 10 Sep 2007 15:07:25 +0300 by phpDocumentor 1.3.2