GoogleApiAdsAdWords
[ class tree: GoogleApiAdsAdWords ] [ index: GoogleApiAdsAdWords ] [ all elements ]

Class: InfoSelector

Source Location: /AdWords/v200909/info/InfoService.php

Class Overview


Specifies the type of API usage information to be returned. API usage information returned is based on the #apiUsageType specified. All returned values are specific to the developer token being used to call
.


Variables

Methods



Class Details

[line 942]
Specifies the type of API usage information to be returned. API usage information returned is based on the #apiUsageType specified. All returned values are specific to the developer token being used to call
.

For each of the

values, other
fields must also be set as described below:

    1. FREE_USAGE_API_UNITS_PER_MONTH
    : Returns the number of allocated <a href="http://www.google.com/support/adwordsapi/bin/answer.py?answer=45891"> free API units</a> for this entire month. Specify only the apiUsageType parameter.
    1. TOTAL_USAGE_API_UNITS_PER_MONTH
    : Returns the total number of allocated API units for this entire month. Includes both free and paid API units. Specify only the apiUsageType parameter.
    1. OPERATION_COUNT
    : Returns the number of operations recorded over the given date range. The given dates are inclusive; to get the operation count for a single day, supply it as both the start and end date. Specify the apiUsageType and dateRange parameters.
    1. UNIT_COUNT
    : Returns the number of API units recorded.
    • Specify the apiUsageType and dateRange parameters to retrieve the units recorded over the given date range.
    • Specify the apiUsageType, serviceName, methodName and dateRange to retrieve the units recorded over the given date range for a specified method.
    1. UNIT_COUNT_FOR_CLIENTS
    : Returns the number of API units recorded for a subset of clients over the given date range. The given dates are inclusive; to get the unit count for a single day, supply it as both the start and end date. Specify the apiUsageType, dateRange and clientEmails parameters.
    1. METHOD_COST
    : Returns the cost, in API units per operation, of the given method on a specific date. Methods default to a cost of 1. Specify the apiUsageType, dateRange (start date and end date should be the same), serviceName, methodName, operator parameters.




[ Top ]


Class Variables

$apiUsageType =

[line 977]



Tags:

access:  public

Type:   tnsApiUsageType


[ Top ]

$clientEmails =

[line 971]



Tags:

access:  public

Type:   string[]


[ Top ]

$dateRange =

[line 965]



Tags:

access:  public

Type:   DateRange


[ Top ]

$methodName =

[line 953]



Tags:

access:  public

Type:   string


[ Top ]

$operator =

[line 959]



Tags:

access:  public

Type:   cmOperator


[ Top ]

$serviceName =

[line 947]



Tags:

access:  public

Type:   string


[ Top ]



Class Methods


constructor __construct [line 995]

InfoSelector __construct( [ $serviceName = NULL], [ $methodName = NULL], [ $operator = NULL], [ $dateRange = NULL], [ $clientEmails = NULL], [ $apiUsageType = NULL])



Tags:

access:  public


Parameters:

   $serviceName  
   $methodName  
   $operator  
   $dateRange  
   $clientEmails  
   $apiUsageType  

[ Top ]

method getNamespace [line 983]

the getNamespace( )

Gets the namesapce of this class



Tags:

return:  namespace of this class
access:  public


[ Top ]

method getXsiTypeName [line 991]

the getXsiTypeName( )

Gets the xsi:type name of this class



Tags:

return:  xsi:type name of this class
access:  public


[ Top ]


Documentation generated by phpDocumentor 1.4.3