Request Headers

When sending a request to any of the AdWords API web services, you must provide the following headers with your request:

authToken

Identifies either an MCC manager acting on behalf of a client, or an advertiser directly managing their own account. You retrieve this token by posting your account login and password to the Google ClientLogin API. An authentication token is valid for about a week after you acquire it; when it expires, use ClientLogin to retrieve a new one.

Required parameters: When you use ClientLogin to retrieve an authentication token for the AdWords API, you must also pass the following parameters to ClientLogin:

Parameter	Value
service	adwords

Recommended parameters: As a best practice, you should also pass the following parameters to ClientLogin:

Parameter	Value
accountType	GOOGLE
source	companyName-userAgent-versionID

developerToken

A 22-character string that uniquely identifies an AdWords API developer. An example developer token string is ABcdeFGH93KL-NOPQ_STUv.

userAgent

An arbitrary string that defines the sender and purpose of the request.

clientCustomerId

When acting on behalf of a client, this header specifies that client's customer ID. Customer IDs are typically of the form 123-456-7890.

validateOnly (optional)

If set to true, the request is validated but not performed. You can use this header to validate user-provided data.

partialFailure (optional; AdGroupCriterionService, AdGroupAdService; v201206+: AdGroupService, CampaignService, CampaignAdExtensionService, CampaignCriterionService)

If set to true, the service will perform error-free operations and return the failing operations' errors. This header is ignored for non-mutate operations.

Response Headers

The following headers are returned with the response XML. For support and debugging purposes, we recommend that you log these values.

requestId

String that uniquely identifies this request.

operations

Number of operations performed in this request.

responseTime

Elapsed time in milliseconds between the web service receiving the request and sending the response.

units

Total number of API units consumed by this request. Note that this field is now obsolete and will always be 0.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.