For advanced users we've provided this list of the currently supported custom search style parameters. The code you generate in AdSense contains all of the most commonly used parameter settings. There are two required parameters: pubId and query. AdSense provides the pubId but you must edit the code and pass a value for the query parameter. All of the other parameters are optional and are described below.
Parameter types
There are two types of parameters:
- Page level parameters which apply to all ad units on the page
- Unit level parameters which apply to individual ad units.
Here's some example output from the code generator with two ad blocks. To configure this code, you must set the required query parameter in the pageOptions map (e.g., “query”: myQuery). This is all that’s required to start showing ads. You can also set optional page level parameters in the page level block and individual unit level parameters in the adblock1 and adblock2 maps.
<div id="afscontainer2"></div>
<script type="text/javascript" charset="utf-8">
// Page level parameters
var pageOptions = {
"pubId": "partner-pub-1234567891234567",
"styleId": "1234567890",
"query": myQuery,
};
// Unit level parameters
var adblock1 = {
"container": "afscontainer1"
};
var adblock2 = {
"container": "afscontainer2"
};
_googCsa('ads', pageOptions, adblock1, adblock2);
</script>
Page level parameter descriptions
These parameters only need to be specified once per page. They affect all units on the page.
Required
| Parameter | Description and examples |
|---|---|
pubId |
Required This is your AdSense client-ID. Your pubId is the part of your client-ID that comes after 'partner-'. For example, if your client-ID is 'partner-test-property', your pubId is 'test-property'. This is standard protocol for CSA. Example: 'pubId' : 'test-property' |
query |
Required This is the search query entered by the user. The value of the query parameter should be unencoded. Examples:
|
Optional configuration settings
| Parameter | Description and examples | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adPage |
Optional
The |
|||||||||||||||||||||||||||||||||||||||||||||||||||
adsafe |
Optional Specifies the filtering rules that Google should apply to ads matching the search query. The following are the valid settings for adsafe and the effect each value has on returned ads:
By default
adsafe is set to 'high'.Example: 'adsafe': 'medium' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
adtest |
Optional The adtest parameter is used to indicate that a request for ads is a test. When the adtest parameter has a value of 'on', Google treats the request as a test and does not count the ad impressions or track the clickthrough results.
When the Use this parameter when testing, but do not use it in production systems or you will not be paid for ads that you display.
The default adtest value is 'off'. Example: 'adtest' : 'on' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
channel |
Optional You may include an AdSense for Search channel for tracking the performance of different pages. Use the unique channel ID you created in your AdSense account. Learn more about tracking ad performance with custom channels. Multiple channels should be separated by the '+' symbol. Examples: 'channel' : 'testA' 'channel' : 'testA+testB' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
hl |
Optional This parameter identifies the language that the requested ads should target. The default value is 'en'. Google supports all Google Ads API language codes. Advertisers specify the languages that their ads target. If you include this parameter in your request, Google only returns ads that are targeted for that language or targeted for all languages but it does not guarantee that the ad text will be in the specified language.
Typically, you should set the Examples: 'hl' : 'es' |
|||||||||||||||||||||||||||||||||||||||||||||||||||
ie |
Optional
The The default
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
oe |
Optional
The The default |
|||||||||||||||||||||||||||||||||||||||||||||||||||
personalizedAds |
Optional Specifies whether users have consented to allowing the publisher to share personal information with Google for the purpose of personalized advertising.
By default
personalizedAds is set to 'true'.Example: 'personalizedAds': false |
Unit level parameter descriptions
These parameters affect the way individual ad units on a page are presented to the user. Each parameter can be set individually for each ad unit.
Required
| Parameter | Description and examples |
|---|---|
container |
Required The id of the empty ad container <div id='afscontainer1'></div> where the ad should appear.
Example:
|
Optional configuration settings
| Parameter | Description and examples |
|---|---|
maxTop |
Optional
Use this parameter to specify the number of ads to be shown on the top ad unit. This parameter is used in place of the
number parameter. This ad unit should be wide enough so the first line of the ads doesn't wrap. Using the maxTop parameter on any other placement on the page is a policy violation.Example:
|
number |
Optional The number of ads which should appear in this unit. The default value is '2'. Example:
|
width |
Required Specifies the width of the ad unit in pixels. Example:
|
