Service
InfoService
Dependencies
Specifies the type of API usage information to be returned. API usage information
returned is based on the API usage type specified. All returned
values are specific to the developer token being used to call InfoService.get.
For each of the apiUsageType values, other InfoSelector
fields must also be set as described below:
-
FREE_USAGE_API_UNITS_PER_MONTH: Returns the number of allocated free API units for this entire month. Specify only the apiUsageType parameter. -
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. -
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. -
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.
-
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. -
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.
- Namespace
-
https://adwords.google.com/api/adwords/info/v201209 - Fields
| Field | Type | Description |
|---|---|---|
| serviceName |
xsd:string
|
The name of the service. |
| methodName |
xsd:string
|
The method whose cost has been queried. |
| operator |
cm:Operator
|
Specifies the operator. This is applicable when the method is a "mutate" method. Enumerations
|
| dateRange |
cm:DateRange
|
Date range to get the API usage for. The given dates are inclusive; to get the usage information for a single day, supply it as both the start and end date. |
| clientEmails |
xsd:string[]
|
List of login emails used to identify the clients to retrieve the API usage for. If the list is null or empty, return the API usage for all clients. NOTE: Only one of clientEmails or clientCustomerIds may be specified at once. |
| clientCustomerIds |
xsd:long[]
|
List of login customer IDs used to identify the clients to retrieve the API usage for. If the list is null or empty, return the API usage for all clients. NOTE: Only one of clientEmails or clientCustomerIds may be specified at once. |
| includeSubAccounts |
xsd:boolean
|
If true, include child accounts of the MCC in the search. |
| apiUsageType Required
|
ApiUsageType
|
The API usage type information that needs to be fetched.
This field is required and should not be null.
Enumerations
|