public static final class

DynamicHeightSearchAdRequest.Builder

extends Object
java.lang.Object
   ↳ com.google.android.gms.ads.search.DynamicHeightSearchAdRequest.Builder

Class Overview

Builds a DynamicHeightSearchAdRequest.

Summary

Public Constructors
DynamicHeightSearchAdRequest.Builder()
Public Methods
DynamicHeightSearchAdRequest.Builder addCustomEventExtrasBundle(Class<? extends CustomEvent> adapterClass, Bundle customEventExtras)
Add extra parameters to pass to a specific custom event adapter.
DynamicHeightSearchAdRequest.Builder addNetworkExtras(NetworkExtras networkExtras)
Add extra parameters to pass to a specific ad network adapter.
DynamicHeightSearchAdRequest.Builder addNetworkExtrasBundle(Class<? extends MediationAdapter> adapterClass, Bundle networkExtras)
Add extra parameters to pass to a specific ad network adapter.
DynamicHeightSearchAdRequest build()
Constructs a DynamicHeightSearchAdRequest with the specified attributes.
DynamicHeightSearchAdRequest.Builder setAdBorderSelectors(String adBorderSelectors)
The CSA "adBorderSelections" parameter.
DynamicHeightSearchAdRequest.Builder setAdTest(boolean adTest)
Indicates if the CSA "adTest" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setAdjustableLineHeight(int adjustableLineHeight)
The CSA "adjustableLineHeight" parameter.
DynamicHeightSearchAdRequest.Builder setAdvancedOptionValue(String key, String value)
Sets an advanced option value for a specified key.
DynamicHeightSearchAdRequest.Builder setAttributionSpacingBelow(int attributionSpacingBelow)
The CSA "attributionSpacingBelow" parameter.
DynamicHeightSearchAdRequest.Builder setBorderSelections(String borderSelections)
The CSA "borderSelections" parameter.
DynamicHeightSearchAdRequest.Builder setChannel(String channel)
The CSA "channel" parameter.
DynamicHeightSearchAdRequest.Builder setColorAdBorder(String colorAdBorder)
The CSA "colorAdBorder" parameter.
DynamicHeightSearchAdRequest.Builder setColorAdSeparator(String colorAdSeparator)
The CSA "colorAdSeparator" parameter.
DynamicHeightSearchAdRequest.Builder setColorAnnotation(String colorAnnotation)
The CSA "colorAnnotation" parameter.
DynamicHeightSearchAdRequest.Builder setColorAttribution(String colorAttribution)
The CSA "colorAttribution" parameter.
DynamicHeightSearchAdRequest.Builder setColorBackground(String colorBackground)
The CSA "colorBackground" parameter.
DynamicHeightSearchAdRequest.Builder setColorBorder(String colorBorder)
The CSA "colorBorder" parameter.
DynamicHeightSearchAdRequest.Builder setColorDomainLink(String colorDomainLink)
The CSA "colorDomainLink" parameter.
DynamicHeightSearchAdRequest.Builder setColorText(String colorText)
The CSA "colorText" parameter.
DynamicHeightSearchAdRequest.Builder setColorTitleLink(String colorTitleLink)
The CSA "colorTitleLink" parameter.
DynamicHeightSearchAdRequest.Builder setCssWidth(int width)
The CSA "width" parameter.
DynamicHeightSearchAdRequest.Builder setDetailedAttribution(boolean detailedAttribution)
Indicates if the CSA "detailedAttribution" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setFontFamily(String fontFamily)
The CSA "fontFamily" parameter.
DynamicHeightSearchAdRequest.Builder setFontFamily(int fontFamily)
This method is deprecated. Use setFontFamily(String fontFamily) instead.
DynamicHeightSearchAdRequest.Builder setFontFamilyAttribution(String fontFamilyAttribution)
The CSA "fontFamilyAttribution" parameter.
DynamicHeightSearchAdRequest.Builder setFontSizeAnnotation(int fontSizeAnnotation)
The CSA "fontSizeAnnotation" parameter.
DynamicHeightSearchAdRequest.Builder setFontSizeAttribution(int fontSizeAttribution)
The CSA "fontSizeAttribution" parameter.
DynamicHeightSearchAdRequest.Builder setFontSizeDescription(int fontSizeDescription)
The CSA "fontSizeDescription" parameter.
DynamicHeightSearchAdRequest.Builder setFontSizeDomainLink(int fontSizeDomainLink)
The CSA "fontSizeDomainLink" parameter.
DynamicHeightSearchAdRequest.Builder setFontSizeTitle(int fontSizeTitle)
The CSA "fontSizeTitle" parameter.
DynamicHeightSearchAdRequest.Builder setHostLanguage(String hostLanguage)
The CSA "hl" parameter.
DynamicHeightSearchAdRequest.Builder setIsClickToCallEnabled(boolean isClickToCallEnabled)
Indicates if the CSA "clickToCall" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setIsLocationEnabled(boolean isLocationEnabled)
Indicates if the CSA "location" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setIsPlusOnesEnabled(boolean isPlusOnesEnabled)
Indicates if the CSA "plusOnes" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setIsSellerRatingsEnabled(boolean isSellerRatingsEnabled)
Indicates if the CSA "sellerRatings" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setIsSiteLinksEnabled(boolean isSiteLinksEnabled)
Indicates if the CSA "siteLinks" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setIsTitleBold(boolean isTitleBold)
Indicates if the CSA "titleBold" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setIsTitleUnderlined(boolean isTitleUnderlined)
Indicates if the CSA "noTitleUnderline" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setLocationColor(String locationColor)
The CSA "colorLocation" parameter.
DynamicHeightSearchAdRequest.Builder setLocationFontSize(int locationFontSize)
The CSA "fontSizeLocation" parameter.
DynamicHeightSearchAdRequest.Builder setLongerHeadlines(boolean longerHeadlines)
Indicates if the CSA "longerHeadlines" parameter is enabled.
DynamicHeightSearchAdRequest.Builder setNumber(int numberOfAds)
The CSA "number" parameter.
DynamicHeightSearchAdRequest.Builder setPage(int adPage)
The CSA "adPage" parameter.
DynamicHeightSearchAdRequest.Builder setQuery(String query)
Sets the query for requesting a search ad.
DynamicHeightSearchAdRequest.Builder setVerticalSpacing(int verticalSpacing)
The CSA "verticalSpacing" parameter.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DynamicHeightSearchAdRequest.Builder ()

Public Methods

public DynamicHeightSearchAdRequest.Builder addCustomEventExtrasBundle (Class<? extends CustomEvent> adapterClass, Bundle customEventExtras)

Add extra parameters to pass to a specific custom event adapter.

Parameters
adapterClass Class: The Class of the custom event adapter for which you are providing extras.
customEventExtras Bundle: A Bundle of extra information to pass to a custom event adapter.
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder addNetworkExtras (NetworkExtras networkExtras)

Add extra parameters to pass to a specific ad network adapter. The networkExtras parameter should be an instance of com.google.ads.mediation.NetworkExtras, which is provided by ad network adapters.

Note that the NetworkExtras class has been deprecated. This method is included to maintain compatibility with older adapters.

Parameters
networkExtras NetworkExtras
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder addNetworkExtrasBundle (Class<? extends MediationAdapter> adapterClass, Bundle networkExtras)

Add extra parameters to pass to a specific ad network adapter.

Parameters
adapterClass Class: The Class of the adapter for the network for which you are providing extras.
networkExtras Bundle: A Bundle of extra information to pass to a mediation adapter.
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest build ()

Constructs a DynamicHeightSearchAdRequest with the specified attributes.

Returns
DynamicHeightSearchAdRequest

public DynamicHeightSearchAdRequest.Builder setAdBorderSelectors (String adBorderSelectors)

The CSA "adBorderSelections" parameter.

Specifies border lines for each ad in the ad unit. This must be used in conjunction with the colorAdBorder parameter. The following values are valid for adBorderSelections: 'top', 'right', 'bottom', 'left'

Parameters
adBorderSelectors String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setAdTest (boolean adTest)

Indicates if the CSA "adTest" parameter is enabled.

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.

Parameters
adTest boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setAdjustableLineHeight (int adjustableLineHeight)

The CSA "adjustableLineHeight" parameter.

Specifies the line height for the title, description, and visible url ad elements. Note that the line height includes the ad element text. If the line height is greater than the text, the text is centered vertically and the remaining pixels are distributed equally as padding above and below the text.

Parameters
adjustableLineHeight int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setAdvancedOptionValue (String key, String value)

Sets an advanced option value for a specified key.

Parameters
key String
value String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setAttributionSpacingBelow (int attributionSpacingBelow)

The CSA "attributionSpacingBelow" parameter.

Specifies the amount of vertical spacing between the attribution and the ads in pixels. Note that 4px of padding are automatically added and this value specifies the number of additional pixels.

Parameters
attributionSpacingBelow int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setBorderSelections (String borderSelections)

The CSA "borderSelections" parameter.

Specifies border lines for the ad unit. This must be used in conjunction with the colorBorder parameter. The following values are valid for borderSelections: 'top', 'right', 'bottom', 'left'

Parameters
borderSelections String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setChannel (String channel)

The CSA "channel" parameter.

An AdSense for Search channel ID may be included for tracking the performance of different pages.

Parameters
channel String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorAdBorder (String colorAdBorder)

The CSA "colorAdBorder" parameter.

Places a border in the specified color around an individual ad and creates a "box" look around each ad.

Parameters
colorAdBorder String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorAdSeparator (String colorAdSeparator)

The CSA "colorAdSeparator" parameter.

Places a 1px border between the ads in an ad block. The default is off with no border between ads.

Parameters
colorAdSeparator String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorAnnotation (String colorAnnotation)

The CSA "colorAnnotation" parameter.

Specifies the color of the text annotations (e.g. siteLinks, plusOnes).

Parameters
colorAnnotation String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorAttribution (String colorAttribution)

The CSA "colorAttribution" parameter.

Specifies the color of the attribution.

Parameters
colorAttribution String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorBackground (String colorBackground)

The CSA "colorBackground" parameter.

Specifies the background color of the ad.

Parameters
colorBackground String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorBorder (String colorBorder)

The CSA "colorBorder" parameter.

Specifies a 1px border color for the ad unit. If none is provided the ad unit will have no border.

Parameters
colorBorder String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorDomainLink (String colorDomainLink)

The CSA "colorDomainLink" parameter.

Specifies the color of the link to the advertiser's site.

Parameters
colorDomainLink String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorText (String colorText)

The CSA "colorText" parameter.

Specifies the color of the ad description text.

Parameters
colorText String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setColorTitleLink (String colorTitleLink)

The CSA "colorTitleLink" parameter.

Specifies the color of the ad title.

Parameters
colorTitleLink String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setCssWidth (int width)

The CSA "width" parameter.

Specifies the width of the ad unit in pixels.

Parameters
width int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setDetailedAttribution (boolean detailedAttribution)

Indicates if the CSA "detailedAttribution" parameter is enabled.

Extends the attribution to include the user query.

Parameters
detailedAttribution boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontFamily (String fontFamily)

The CSA "fontFamily" parameter.

Specifies the font family of the entire ad unit. The default font is Arial. This parameter supports a comma-separated list of fonts.

Parameters
fontFamily String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontFamily (int fontFamily)

This method is deprecated.
Use setFontFamily(String fontFamily) instead.

Parameters
fontFamily int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontFamilyAttribution (String fontFamilyAttribution)

The CSA "fontFamilyAttribution" parameter.

Specifies the font family of the attribution. The default font is Arial. This parameter supports a comma-separated list of fonts.

Parameters
fontFamilyAttribution String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontSizeAnnotation (int fontSizeAnnotation)

The CSA "fontSizeAnnotation" parameter.

Specifies the size (in pixels) of the text annotations (e.g. siteLinks, plusOnes).

Parameters
fontSizeAnnotation int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontSizeAttribution (int fontSizeAttribution)

The CSA "fontSizeAttribution" parameter.

Specifies the size (in pixels) of the attribution.

Parameters
fontSizeAttribution int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontSizeDescription (int fontSizeDescription)

The CSA "fontSizeDescription" parameter.

Specifies the size (in pixels) of the ad description text.

Parameters
fontSizeDescription int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontSizeDomainLink (int fontSizeDomainLink)

The CSA "fontSizeDomainLink" parameter.

Specifies the size (in pixels) of the link to the advertiser's site.

Parameters
fontSizeDomainLink int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setFontSizeTitle (int fontSizeTitle)

The CSA "fontSizeTitle" parameter.

Specifies the size (in pixels) of the ad title.

Parameters
fontSizeTitle int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setHostLanguage (String hostLanguage)

The CSA "hl" parameter.

Identifies the language that the requested ads should target.

Parameters
hostLanguage String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsClickToCallEnabled (boolean isClickToCallEnabled)

Indicates if the CSA "clickToCall" parameter is enabled.

Allow or disallow click to call ads.

Parameters
isClickToCallEnabled boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsLocationEnabled (boolean isLocationEnabled)

Indicates if the CSA "location" parameter is enabled.

Provides a way for the ad to display location information such as the address.

Parameters
isLocationEnabled boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsPlusOnesEnabled (boolean isPlusOnesEnabled)

Indicates if the CSA "plusOnes" parameter is enabled.

Enables social annotations for ads.

Parameters
isPlusOnesEnabled boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsSellerRatingsEnabled (boolean isSellerRatingsEnabled)

Indicates if the CSA "sellerRatings" parameter is enabled.

Seller rating extensions provide user-submitted ratings information about sellers next to their ads.

Parameters
isSellerRatingsEnabled boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsSiteLinksEnabled (boolean isSiteLinksEnabled)

Indicates if the CSA "siteLinks" parameter is enabled.

Ad Sitelinks is a feature that lets advertisers include up to 4 additional links to deeper content on their site beyond the main landing page.

Parameters
isSiteLinksEnabled boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsTitleBold (boolean isTitleBold)

Indicates if the CSA "titleBold" parameter is enabled.

Allows the entire ad title line to be bold.

Parameters
isTitleBold boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setIsTitleUnderlined (boolean isTitleUnderlined)

Indicates if the CSA "noTitleUnderline" parameter is enabled.

Specifies whether or not the ad title will be underlined. The default is true (ads will have an underline).

Parameters
isTitleUnderlined boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setLocationColor (String locationColor)

The CSA "colorLocation" parameter.

Specifies the color of the location extension.

Parameters
locationColor String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setLocationFontSize (int locationFontSize)

The CSA "fontSizeLocation" parameter.

Specifies the font size of the location extension.

Parameters
locationFontSize int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setLongerHeadlines (boolean longerHeadlines)

Indicates if the CSA "longerHeadlines" parameter is enabled.

Longer Headlines extends ad headlines by appending the first description line and/or display URL under certain conditions, promoting important information to the headline.

Parameters
longerHeadlines boolean
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setNumber (int numberOfAds)

The CSA "number" parameter.

The number of ads which should appear in this unit.

Parameters
numberOfAds int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setPage (int adPage)

The CSA "adPage" parameter.

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.

Parameters
adPage int
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setQuery (String query)

Sets the query for requesting a search ad. The query must be set to receive an ad.

Parameters
query String
Returns
DynamicHeightSearchAdRequest.Builder

public DynamicHeightSearchAdRequest.Builder setVerticalSpacing (int verticalSpacing)

The CSA "verticalSpacing" parameter.

Specifies the amount of vertical spacing between ads in pixels. Note that 4px of padding are automatically added to the top and bottom of each ad for a total of 8 pixels. The default value for verticalSpacing is 4, the min is 2, and the max is 12.

Parameters
verticalSpacing int
Returns
DynamicHeightSearchAdRequest.Builder