Docs For Class AdWordInfoService

AdWordInfoService

Description

AdWords Lib Info Service Class

Use this class to work with Google AdWords Info Service. The Info Service allows customers to obtain some basic information about their API usage

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

Located in /services/AdWordInfoService.inc

AdWordService
   |
   --AdWordInfoService

Method Summary

AdWordInfoService AdWordInfoService (string $soapToolkit)

int|false getFreeUsageQuotaThisMonth ([string $clientEmail = ''])

int|false getMethodCost (string $service, string $method, string $date, [string $clientEmail = ''])

int|false getOperationCount (string $startDate, string $endDate, [string $clientEmail = ''])

int|false getOperationsQuotaThisMonth ([string $clientEmail = ''])

int|false getUnitCount (string $startDate, string $endDate, [string $clientEmail = ''])

array|false getUnitCountForClients (string $clientEmails, string $startDate, string $endDate, [string $clientEmail = ''])

int|false getUnitCountForMethod (string $service, string $method, string $startDate, string $endDate, [string $clientEmail = ''])

int|false getUsageQuotaThisMonth ([string $clientEmail = ''])

Methods

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

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 ?>

Please use defined constants for supported by AdWords Lib toolkit names

see: AdWordsConsts.inc

AdWordInfoService AdWordInfoService (string $soapToolkit)

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

Designed specifically for AdWords Commercial Developer Program participants.

Retrieves this month's free usage quota for the developer token being used to make this call. For those not enrolled in the AdWords Commercial Developer Program, this value will be identical to that returned for getUsageQuotaThisMonth.

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $infoService->getFreeUsageQuotaThisMonth();
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: this month's operations quota, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getFreeUsageQuotaThisMonth For more information about getFreeUsageQuotaThisMonth see in Google AdWords Developer's Guide

int|false getFreeUsageQuotaThisMonth ([string $clientEmail = ''])

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

Retrieves the cost, in quota units per operation, of the given method on a specific date.

Methods default to a cost of 1.

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $service = 'ReportService';
 $method = 'scheduleReportJob';
 $date = '2005-02-01T00:00:00Z';
 $response = $infoService->getMethodCost($service, $method, $date);
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: the cost, in quota units per operation, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getMethodCost For more information about getMethodCost see in Google AdWords Developer's Guide

int|false getMethodCost (string $service, string $method, string $date, [string $clientEmail = ''])

string $service: The name of the service containing the method, for example, "ReportService".
string $method: The method whose quota cost is being queried, for example "scheduleReportJob".
string $date: The date for which to retrieve the cost of the method. An error occurs if this date is in the future.
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Retrieves the number of operations recorded for the developer token being used to make this call over a given period

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $start = '2005-01-01T00:00:00Z';
 $end = '2005-02-01T00:00:00Z';
 $response = $infoService->getOperationCount($start, $end);
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is the number of operations recorded for the developer token
 //being used to make this call over the given date range
 ?>

return: number of operations recorded for the developer token being used to make this call over the given date range, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getOperationCount For more information about getOperationCount see in Google AdWords Developer's Guide

int|false getOperationCount (string $startDate, string $endDate, [string $clientEmail = ''])

string $startDate: beginning of the period
string $endDate: end of the period
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Retrieves this month's operations quota for the developer token being used to make this call

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $infoService->getOperationsQuotaThisMonth();
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is this month's operations quota for the developer token
 //being used to make this call
 ?>

return: this month's operations quota, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getOperationsQuotaThisMonth For more information about getOperationsQuotaThisMonth see in Google AdWords Developer's Guide

int|false getOperationsQuotaThisMonth ([string $clientEmail = ''])

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

Retrieves the number of quota units recorded for the developer token being used to make this call over the given date range.

The time zone is implicitly assumed to be Pacific time (PST or PDT). The given dates are inclusive; to get the unit count for a single day, supply it as both the start and end date. An error occurs if the startDate falls after the endDate or if either date is in the future.

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $start = '2005-01-01T00:00:00Z';
 $end = '2005-02-01T00:00:00Z';
 $response = $infoService->getUnitCount($start, $end);
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 //$response is the number of operations recorded for the developer token
 //being used to make this call over the given date range
 ?>

return: number of operations recorded for the developer token being used to make this call over the given date range, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getUnitCount For more information about getUnitCount see in Google AdWords Developer's Guide

int|false getUnitCount (string $startDate, string $endDate, [string $clientEmail = ''])

string $startDate: beginning of the period
string $endDate: end of the period
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Retrieves the number of quota units recorded for a subset of clients over the given date range.

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $clientEmails = array('john.doe@mail.com', 'jane.dean@mail.com');
 $start = '2006-01-01T00:00:00Z';
 $end = '2006-02-01T00:00:00Z';
 $response = $infoService->getUnitCountForClients($clientEmails, $start, $end);
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: array of objects of class ClientUsageRecord, could be empty if there was no usage for the given clients and date range; or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getUnitCountForClients For more information about getUnitCountForClients see in Google AdWords Developer's Guide

array|false getUnitCountForClients (string $clientEmails, string $startDate, string $endDate, [string $clientEmail = ''])

string $clientEmails: list of login email used to identify the clients to retrieve quota units for. If the array is null or empty, this call will list the quota units for all clients.
string $startDate: the beginning of the date range, inclusive.
string $endDate: the end of the date range, inclusive.
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Retrieves the number of quota units recorded for the developer token being used to make this call over the given date range for a specific method.

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $service = 'ReportService';
 $method = 'scheduleReportJob';
 $startDate = '2005-02-01T00:00:00Z';
 $endDate = '2005-04-01T00:00:00Z';
 $response = $infoService->getUnitCountForMethod($service, $method, $startDate, $endDate);
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: the cost, in quota units per operation, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getUnitCountForMethod For more information about getUnitCountForMethod see in Google AdWords Developer's Guide

int|false getUnitCountForMethod (string $service, string $method, string $startDate, string $endDate, [string $clientEmail = ''])

string $service: The name of the service containing the method, for example, "ReportService".
string $method: The method whose quota cost is being queried, for example "scheduleReportJob".
string $startDate: The beginning of the date range, inclusive.
string $endDate: The end of the date range, inclusive.
string $clientEmail: provide the clientEmail when you want to edit a client's account rather than your own account

Retrieves this month's total usage quota, including free quota usage, or the developer token being used to make this call.

Example:

 <?php
 $infoService = new AdWordInfoService(ADWORD_SOAP_TOOLKIT_NUSOAP);
 $infoService->setAccount($myEmail, $myPass, $myUserAgent, $myDeveloperToken, $myApplicationToken);
 $response = $infoService->getUsageQuotaThisMonth();
 if ($response === false) { // if an error appears
         $errr = $infoService->getLastError(); //get error object
         echo $errr->toString(); //output error
         exit();
 }
 ?>

return: this month's operations quota, or false on error
link: http://www.google.com/apis/adwords/developer/InfoService.html#getUsageQuotaThisMonth For more information about getUsageQuotaThisMonth see in Google AdWords Developer's Guide

int|false getUsageQuotaThisMonth ([string $clientEmail = ''])

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:21 +0300 by phpDocumentor 1.3.2