Reference

The adPage parameter specifies the results page ads are being displayed on. This parameter is used when users navigate past the first page of search results. For example, if five ads are requested, and the adPage parameter is set to 2, the returned ads will be the second page of five ads.

Example:

'pubId' : 'test-property'

Note: Using this parameter on Related Search on Content pages will cause unexpected results.

Examples:

'query' : 'flowers'

'query' : 'black & decker'

'query' : myQuery // myQuery is a variable containing the search query

Example:

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'

• 'content' Use this option for Related Search on Content pages (e.g., articles, blog posts).
• 'query' Use this option exclusively for Related Search on Search results pages.

Note:The relatedSearchTargeting page parameter is automatically set to 'query' by default. However, it's crucial to note that this default value is specifically designed for search results pages only (Related Search on Search). If you are using related search on any other type of page (e.g., articles, blog posts), you must explicitly set the parameter to 'content'.

Note: The following guidelines apply to use of this parameter:

• Certain related search features may be enabled or disabled depending on the value of this page parameter.
• Misrepresenting the type of page or relying on the default 'query' setting for the relatedSearchTargeting parameter on non-search results pages is considered a violation of these written instructions.
• Google may periodically verify the accuracy of this value, regardless of whether it's set manually or using the default.

Examples:

'relatedSearchTargeting' : 'content'

'relatedSearchTargeting' : 'query'

Example:

'styleId': '1234567890'

• '_top' Opens in the same window.
• '_blank' Opens in a new window.

Example:

'linkTarget' : '_blank'

Example:

'maxTermLength' : 50

The following guidelines apply to use of this parameter:

• The parameter should only be provided on a Related Search for Content request, and it will be ignored on all other requests.
• It should only be used on the traffic that you intentionally source from other websites, and should not be used on organic traffic.
• It should include the title line, the description, and/or any other wording in the ad or link creative.
• Omitting values from the ad or link creative (or including additional values) is considered a violation of these written instructions.
• It is case insensitive.
• It accepts valid UTF-8 encoding; unicode characters / diacritics are supported.
• Google may use or ignore the parameter you submit. When used, it may affect the selection and ranking of the terms.

Note: This parameter is required when using the terms parameter.

Examples:

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'

Example:

'resultsPageQueryParam' : 'query'

Note: When using this parameter, referrerAdCreative is also required and relatedSearchTargeting is required and must be set to 'content'.

Examples:

'terms' : 'cars rental, flight ticket'

Note: Before related search terms can appear on your site, Google needs to crawl your pages to ensure the terms are contextually relevant. When a page has not yet been crawled or is blocked from crawling (eg. by a robots.txt) by the AdSense crawler, we will not show suggested Related Search terms you provide to Google.

The Related Search on Content product relies on Google's content crawling system to index pages and generate relevant search terms. Content page URLs containing query parameters such as tracking variables, user IDs, session IDs, or other dynamic identifiers can interfere with the crawler's ability to assess the page's core content and may lead to inaccurate or irrelevant related search terms. This page parameter instructs Google's crawler to disregard these nonessential parameters, ensuring proper content indexing and reducing unnecessary crawl load. This allows Google to better recognize a page as having already been crawled and start showing suggested terms (both Google and the partner's, if eligible).

The following guidelines apply to use of this parameter:

• The parameter should only be provided on a Related Search for Content request, and it will be ignored on all other requests.
• The value of this parameter should be a comma-delimited list of URL parameters that may appear when any user navigates to the content page.
• It is case sensitive.
• When any URL parameter from this list is removed from the content page's URL, there should be no significant impact the pages content, appearance, or user experience.
• Including a URL parameter that does significantly impact the pages content, appearance, or user experience is considered a violation of these written instructions.
• Google may periodically verify the effect of ignoring the provided URL parameters.

Examples:
A user visits a content page and where the URL is:

http://example.com/content?utm_medium=social&page_id=123&click_id=456

'ignoredPageParams' : 'utm_medium,click_id,session_ref'

http://example.com/content?page_id=123

• 'high' Returns family-safe ads. Does not return non-family-safe or adult sexual content ads.
• 'medium' Returns family-safe and non-family-safe ads. Does not return adult sexual content ads.
• 'low' Returns all types of ads.

By default adsafe is set to high.

Example:

'adsafe': 'medium'

When the adtest parameter has a value of on, you do not generate any revenue.

Ad requests with the adtest parameter set to on coming from a domain that hasn't been approved in the Sites tab will return ads that have a "test ad" overlay and are unclickable.

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'

Examples:

'channel' :  'testA'  

'channel' :  'testA+testB'  

Google supports all AdWords API language codes.

Note: 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 hl parameter to the primary language of the page from which this parameter is sent.

Examples:

'hl' : 'es'

The ie parameter sets the character encoding scheme that should be used to interpret the query string.

The default ie value is utf-8.

The oe parameter sets the character encoding scheme that Google should use to encode the text of the ads. While technically optional, it's good practice to pass a value for this parameter.

The default oe value is utf-8.

• true When this parameter isn't present or you set it to "true," we will set an invalid traffic-only cookie and use local storage on consented traffic only.
• false When you set this parameter to "false" we will set an invalid traffic-only cookie and use local storage on both consented and unconsented traffic.

By default IVT is set to true.

Example:

'ivt': false

Example:

'container' : 'afscontainer1'

Use this parameter to specify the number of ads to be shown on the top ad unit.

Note: 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:

'maxTop' : 4

Example:

'width' : '700px'

'width' : 700

The callback function takes following parameters:

Note: Please test your callback function to ensure it does not generate any errors, especially those that might interfere with the loading of your page.

Example of a JavaScript callback:

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
      

Example:

'number' : 4

Example:

'relatedSearches' : 4