ApiError (AdWords API Developer's Guide)

Note: JavaScript must be enabled for you to properly view versions. It seems JavaScript is either disabled or is not supported by your browser, which causes all versions of text to be simultaneously displayed. Enable JavaScript in your browser options, then try again.

Skip to main content Skip to main menu

Introduction
Release Notes
Web Services
Sandbox
API Reference

Close all submenus

Open all submenus
- AccountService
  - AccountInfo
    - Address
    - EmailPromotions
      Preferences
- AdGroupService
  - AdGroup
- AdService
  - Business
  - CommerceAd sandbox
  - ImageAd
    - Image
  - LocalBusinessAd
  - MobileAd
  - TextAd
  - VideoAd
    - Video
- CampaignService
  - Campaign
    - AdSchedule
      - SchedulingInterval
    - BudgetOptimizerSettings
    - ConversionOptimizer Settings +V12
    - GeoTarget
      - CityTargets +V10
      - CountryTargets +V10
      - MetroTargets +V10
      - RegionTargets +V10
      - ProximityTargets +V10
        
        Circle +v10
    - LanguageTarget
    - NetworkTarget
  - ConversionOptimizer Eligibility +V12
- CriterionService
  - Keyword
  - Website
- InfoService
  - ClientUsageRecord
- KeywordToolService
- ReportService
  - DefinedReportJob +V11
  - AccountReportJob −V11
  - AdImageReportJob −V11
  - AdGroupReportJob −V11
  - AdTextReportJob −V11
  - CampaignReportJob −V11
  - CustomReportJob −V11
  - KeywordReportJob −V11
  - UrlReportJob −V11
- SiteSuggestionService +V10
  - DemographicsTarget +V10
  - Language GeoTargeting +V10
  - SiteSuggestion +V10
- TrafficEstimatorService
  - CampaignEstimate
    - AdGroupEstimate
      - KeywordEstimate
  - CampaignRequest
    - AdGroupRequest
      - KeywordRequest
- General Data Types
  - StatsRecord
- Exception Types
  - ApiError
  - ApiException
International Codes
Report Rules +V11
- Account +V11
- Account Structure +V11
- Ad +V11
- Ad Group +V11
- Campaign +V11
- Placement +V11
- Placement / Keyword +V11
- Reach and Frequency +V11
- Url +V11
Error Codes
API Rate Sheet
Index

AdWords API Resources

Developer Forum

AdWords API Blog

ApiError

Represents the details of a user error in the API. Errors are accumulated during the processing of a call and then thrown as part of an ApiException.

Fields

code
detail
field
index
isExemptable
textIndex
textLength
trigger

Field name	Field type	Field description
`code`	`int`	Error code identifying this error.
`detail`	`string`	The error message. A detailed description of the violation.
`field`	`string`	Name of the field in the API data object where the error occurred.
`index`	`int`	Index into input array of the element that caused this error. For example, given an array of Criterion passed in to addCriteria, if the 5th element caused this error, `index` would be value 4.
`isExemptable`	`boolean`	True if user can request an exemption for this violation. For example, this field is true for a trademark violation on a keyword, which means you can request an exemption.
`textIndex`	`int`	The character index into the text string that caused the error. For example, if the problem is with the 5th character in the text of an ad, `textIndex` would be value 4.
`textLength`	`int`	The number of characters in the string that caused the error.
`trigger`	`string`	The text that is in violation of policy