GoogleMobileAds Framework Reference

GADDynamicHeightSearchRequest

@interface GADDynamicHeightSearchRequest : GADRequest

Use to configure Custom Search Ad (CSA) ad requests. A dynamic height search banner can contain multiple ads and the height is set dynamically based on the ad contents. Cross-reference the property sections and properties with the official reference document: https://developers.google.com/custom-search-ads/docs/reference

Required

• query

  The CSA “query” parameter.

  Declaration

  Swift

  var query: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *query;

• adPage

  The CSA “adPage” parameter.

  Declaration

  Swift

  var adPage: Int { get set }

  Objective-C

  @property (nonatomic) NSInteger adPage;

Configuration Settings

• adTestEnabled

  Indicates whether the CSA “adTest” parameter is enabled.

  Declaration

  Swift

  var adTestEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL adTestEnabled;

• channel

  The CSA “channel” parameter.

  Declaration

  Swift

  var channel: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *channel;

• hostLanguage

  The CSA “hl” parameter.

  Declaration

  Swift

  var hostLanguage: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *hostLanguage;

Layout and Styling

• locationExtensionTextColor

  The CSA “colorLocation” parameter.

  Declaration

  Swift

  var locationExtensionTextColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *locationExtensionTextColor;

• locationExtensionFontSize

  The CSA “fontSizeLocation” parameter.

  Declaration

  Swift

  var locationExtensionFontSize: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat locationExtensionFontSize;

Ad Extensions

• clickToCallExtensionEnabled

  Indicates whether the CSA “clickToCall” parameter is enabled.

  Declaration

  Swift

  var clickToCallExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL clickToCallExtensionEnabled;

• locationExtensionEnabled

  Indicates whether the CSA “location” parameter is enabled.

  Declaration

  Swift

  var locationExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL locationExtensionEnabled;

• plusOnesExtensionEnabled

  Indicates whether the CSA “plusOnes” parameter is enabled.

  Declaration

  Swift

  var plusOnesExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL plusOnesExtensionEnabled;

• sellerRatingsExtensionEnabled

  Indicates whether the CSA “sellerRatings” parameter is enabled.

  Declaration

  Swift

  var sellerRatingsExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL sellerRatingsExtensionEnabled;

• siteLinksExtensionEnabled

  Indicates whether the CSA “siteLinks” parameter is enabled.

  Declaration

  Swift

  var siteLinksExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL siteLinksExtensionEnabled;

Required

• CSSWidth

  The CSA “width” parameter.

  Declaration

  Swift

  var cssWidth: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *CSSWidth;

• numberOfAds

  The CSA “number” parameter.

  Declaration

  Swift

  var numberOfAds: Int { get set }

  Objective-C

  @property (nonatomic) NSInteger numberOfAds;

Font

• fontFamily

  The CSA “fontFamily” parameter.

  Declaration

  Swift

  var fontFamily: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *fontFamily;

• attributionFontFamily

  The CSA “fontFamilyAttribution” parameter.

  Declaration

  Swift

  var attributionFontFamily: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *attributionFontFamily;

• annotationFontSize

  The CSA “fontSizeAnnotation” parameter.

  Declaration

  Swift

  var annotationFontSize: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat annotationFontSize;

• attributionFontSize

  The CSA “fontSizeAttribution” parameter.

  Declaration

  Swift

  var attributionFontSize: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat attributionFontSize;

• descriptionFontSize

  The CSA “fontSizeDescription” parameter.

  Declaration

  Swift

  var descriptionFontSize: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat descriptionFontSize;

• domainLinkFontSize

  The CSA “fontSizeDomainLink” parameter.

  Declaration

  Swift

  var domainLinkFontSize: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat domainLinkFontSize;

• titleFontSize

  The CSA “fontSizeTitle” parameter.

  Declaration

  Swift

  var titleFontSize: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat titleFontSize;

Color

• adBorderColor

  The CSA “colorAdBorder” parameter.

  Declaration

  Swift

  var adBorderColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *adBorderColor;

• adSeparatorColor

  The CSA “colorAdSeparator” parameter.

  Declaration

  Swift

  var adSeparatorColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *adSeparatorColor;

• annotationTextColor

  The CSA “colorAnnotation” parameter.

  Declaration

  Swift

  var annotationTextColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *annotationTextColor;

• attributionTextColor

  The CSA “colorAttribution” parameter.

  Declaration

  Swift

  var attributionTextColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *attributionTextColor;

• backgroundColor

  The CSA “colorBackground” parameter.

  Declaration

  Swift

  var backgroundColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *backgroundColor;

• borderColor

  The CSA “colorBorder” parameter.

  Declaration

  Swift

  var borderColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *borderColor;

• domainLinkColor

  The CSA “colorDomainLink” parameter.

  Declaration

  Swift

  var domainLinkColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *domainLinkColor;

• textColor

  The CSA “colorText” parameter.

  Declaration

  Swift

  var textColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *textColor;

• titleLinkColor

  The CSA “colorTitleLink” parameter.

  Declaration

  Swift

  var titleLinkColor: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *titleLinkColor;

General Formatting

• adBorderCSSSelections

  The CSA “adBorderSelections” parameter.

  Declaration

  Swift

  var adBorderCSSSelections: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *adBorderCSSSelections;

• adjustableLineHeight

  The CSA “adjustableLineHeight” parameter.

  Declaration

  Swift

  var adjustableLineHeight: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat adjustableLineHeight;

• attributionBottomSpacing

  The CSA “attributionSpacingBelow” parameter.

  Declaration

  Swift

  var attributionBottomSpacing: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat attributionBottomSpacing;

• borderCSSSelections

  The CSA “borderSelections” parameter.

  Declaration

  Swift

  var borderCSSSelections: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *borderCSSSelections;

• titleUnderlineHidden

  Indicates whether the CSA “noTitleUnderline” parameter is enabled.

  Declaration

  Swift

  var titleUnderlineHidden: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL titleUnderlineHidden;

• boldTitleEnabled

  Indicates whether the CSA “titleBold” parameter is enabled.

  Declaration

  Swift

  var boldTitleEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL boldTitleEnabled;

• verticalSpacing

  The CSA “verticalSpacing” parameter.

  Declaration

  Swift

  var verticalSpacing: CGFloat { get set }

  Objective-C

  @property (nonatomic) CGFloat verticalSpacing;

Ad Extensions

• detailedAttributionExtensionEnabled

  Indicates whether the CSA “detailedAttribution” parameter is enabled.

  Declaration

  Swift

  var detailedAttributionExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL detailedAttributionExtensionEnabled;

• longerHeadlinesExtensionEnabled

  Indicates whether the CSA “longerHeadlines” parameter is enabled.

  Declaration

  Swift

  var longerHeadlinesExtensionEnabled: Bool { get set }

  Objective-C

  @property (nonatomic) BOOL longerHeadlinesExtensionEnabled;

• styleID

  The CSA “styleId” parameter.

  Declaration

  Swift

  var styleID: String? { get set }

  Objective-C

  @property (nonatomic, copy, nullable) NSString *styleID;

• -setAdvancedOptionValue:forKey:

  Sets an advanced option value for a specified key. The value must be an NSString or NSNumber.

  Declaration

  Swift

  func setAdvancedOptionValue(_ value: Any, forKey key: String)

  Objective-C

  - (void)setAdvancedOptionValue:(nonnull id)value forKey:(nonnull NSString *)key;