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

  • The CSA “query” parameter.

    Declaration

    Swift

    var query: String? { get set }

    Objective-C

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

  • The CSA “adPage” parameter.

    Declaration

    Swift

    var adPage: Int { get set }

    Objective-C

    @property (nonatomic) NSInteger adPage;

Configuration Settings

  • Indicates whether the CSA “adTest” parameter is enabled.

    Declaration

    Swift

    var adTestEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL adTestEnabled;

  • The CSA “channel” parameter.

    Declaration

    Swift

    var channel: String? { get set }

    Objective-C

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

  • The CSA “hl” parameter.

    Declaration

    Swift

    var hostLanguage: String? { get set }

    Objective-C

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

Layout and Styling

  • The CSA “colorLocation” parameter.

    Declaration

    Swift

    var locationExtensionTextColor: String? { get set }

    Objective-C

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

  • The CSA “fontSizeLocation” parameter.

    Declaration

    Swift

    var locationExtensionFontSize: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat locationExtensionFontSize;

Ad Extensions

  • Indicates whether the CSA “clickToCall” parameter is enabled.

    Declaration

    Swift

    var clickToCallExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL clickToCallExtensionEnabled;

  • Indicates whether the CSA “location” parameter is enabled.

    Declaration

    Swift

    var locationExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL locationExtensionEnabled;

  • Indicates whether the CSA “plusOnes” parameter is enabled.

    Declaration

    Swift

    var plusOnesExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL plusOnesExtensionEnabled;

  • Indicates whether the CSA “sellerRatings” parameter is enabled.

    Declaration

    Swift

    var sellerRatingsExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL sellerRatingsExtensionEnabled;

  • Indicates whether the CSA “siteLinks” parameter is enabled.

    Declaration

    Swift

    var siteLinksExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL siteLinksExtensionEnabled;

Required

  • The CSA “width” parameter.

    Declaration

    Swift

    var cssWidth: String? { get set }

    Objective-C

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

  • The CSA “number” parameter.

    Declaration

    Swift

    var numberOfAds: Int { get set }

    Objective-C

    @property (nonatomic) NSInteger numberOfAds;

Font

  • The CSA “fontFamily” parameter.

    Declaration

    Swift

    var fontFamily: String? { get set }

    Objective-C

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

  • The CSA “fontFamilyAttribution” parameter.

    Declaration

    Swift

    var attributionFontFamily: String? { get set }

    Objective-C

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

  • The CSA “fontSizeAnnotation” parameter.

    Declaration

    Swift

    var annotationFontSize: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat annotationFontSize;

  • The CSA “fontSizeAttribution” parameter.

    Declaration

    Swift

    var attributionFontSize: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat attributionFontSize;

  • The CSA “fontSizeDescription” parameter.

    Declaration

    Swift

    var descriptionFontSize: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat descriptionFontSize;

  • The CSA “fontSizeDomainLink” parameter.

    Declaration

    Swift

    var domainLinkFontSize: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat domainLinkFontSize;

  • The CSA “fontSizeTitle” parameter.

    Declaration

    Swift

    var titleFontSize: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat titleFontSize;

Color

  • The CSA “colorAdBorder” parameter.

    Declaration

    Swift

    var adBorderColor: String? { get set }

    Objective-C

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

  • The CSA “colorAdSeparator” parameter.

    Declaration

    Swift

    var adSeparatorColor: String? { get set }

    Objective-C

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

  • The CSA “colorAnnotation” parameter.

    Declaration

    Swift

    var annotationTextColor: String? { get set }

    Objective-C

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

  • The CSA “colorAttribution” parameter.

    Declaration

    Swift

    var attributionTextColor: String? { get set }

    Objective-C

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

  • The CSA “colorBackground” parameter.

    Declaration

    Swift

    var backgroundColor: String? { get set }

    Objective-C

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

  • The CSA “colorBorder” parameter.

    Declaration

    Swift

    var borderColor: String? { get set }

    Objective-C

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

  • The CSA “colorDomainLink” parameter.

    Declaration

    Swift

    var domainLinkColor: String? { get set }

    Objective-C

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

  • The CSA “colorText” parameter.

    Declaration

    Swift

    var textColor: String? { get set }

    Objective-C

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

  • The CSA “colorTitleLink” parameter.

    Declaration

    Swift

    var titleLinkColor: String? { get set }

    Objective-C

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

General Formatting

  • The CSA “adBorderSelections” parameter.

    Declaration

    Swift

    var adBorderCSSSelections: String? { get set }

    Objective-C

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

  • The CSA “adjustableLineHeight” parameter.

    Declaration

    Swift

    var adjustableLineHeight: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat adjustableLineHeight;

  • The CSA “attributionSpacingBelow” parameter.

    Declaration

    Swift

    var attributionBottomSpacing: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat attributionBottomSpacing;

  • The CSA “borderSelections” parameter.

    Declaration

    Swift

    var borderCSSSelections: String? { get set }

    Objective-C

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

  • Indicates whether the CSA “noTitleUnderline” parameter is enabled.

    Declaration

    Swift

    var titleUnderlineHidden: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL titleUnderlineHidden;

  • Indicates whether the CSA “titleBold” parameter is enabled.

    Declaration

    Swift

    var boldTitleEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL boldTitleEnabled;

  • The CSA “verticalSpacing” parameter.

    Declaration

    Swift

    var verticalSpacing: CGFloat { get set }

    Objective-C

    @property (nonatomic) CGFloat verticalSpacing;

Ad Extensions

  • Indicates whether the CSA “detailedAttribution” parameter is enabled.

    Declaration

    Swift

    var detailedAttributionExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL detailedAttributionExtensionEnabled;

  • Indicates whether the CSA “longerHeadlines” parameter is enabled.

    Declaration

    Swift

    var longerHeadlinesExtensionEnabled: Bool { get set }

    Objective-C

    @property (nonatomic) BOOL longerHeadlinesExtensionEnabled;

  • The CSA “styleId” parameter.

    Declaration

    Swift

    var styleID: String? { get set }

    Objective-C

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

  • 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;