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. Please 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

  Objective-C

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

• adPage

  The CSA adPage parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) NSInteger adPage;

Configuration Settings

• adTestEnabled

  Indicates whether the CSA adTest parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL adTestEnabled;

• channel

  The CSA channel parameter.

  Declaration

  Objective-C

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

• hostLanguage

  The CSA hl parameter.

  Declaration

  Objective-C

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

Layout and Styling

• locationExtensionTextColor

  The CSA colorLocation parameter.

  Declaration

  Objective-C

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

• locationExtensionFontSize

  The CSA fontSizeLocation parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat locationExtensionFontSize;

Ad Extensions

• clickToCallExtensionEnabled

  Indicates whether the CSA clickToCall parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL clickToCallExtensionEnabled;

• locationExtensionEnabled

  Indicates whether the CSA location parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL locationExtensionEnabled;

• plusOnesExtensionEnabled

  Indicates whether the CSA plusOnes parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL plusOnesExtensionEnabled;

• sellerRatingsExtensionEnabled

  Indicates whether the CSA sellerRatings parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL sellerRatingsExtensionEnabled;

• siteLinksExtensionEnabled

  Indicates whether the CSA siteLinks parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL siteLinksExtensionEnabled;

Required

• CSSWidth

  The CSA width parameter.

  Declaration

  Objective-C

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

• numberOfAds

  The CSA number parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) NSInteger numberOfAds;

Font

• fontFamily

  The CSA fontFamily parameter.

  Declaration

  Objective-C

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

• attributionFontFamily

  The CSA fontFamilyAttribution parameter.

  Declaration

  Objective-C

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

• annotationFontSize

  The CSA fontSizeAnnotation parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat annotationFontSize;

• attributionFontSize

  The CSA fontSizeAttribution parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat attributionFontSize;

• descriptionFontSize

  The CSA fontSizeDescription parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat descriptionFontSize;

• domainLinkFontSize

  The CSA fontSizeDomainLink parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat domainLinkFontSize;

• titleFontSize

  The CSA fontSizeTitle parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat titleFontSize;

Color

• adBorderColor

  The CSA colorAdBorder parameter.

  Declaration

  Objective-C

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

• adSeparatorColor

  The CSA colorAdSeparator parameter.

  Declaration

  Objective-C

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

• annotationTextColor

  The CSA colorAnnotation parameter.

  Declaration

  Objective-C

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

• attributionTextColor

  The CSA colorAttribution parameter.

  Declaration

  Objective-C

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

• backgroundColor

  The CSA colorBackground parameter.

  Declaration

  Objective-C

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

• borderColor

  The CSA colorBorder parameter.

  Declaration

  Objective-C

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

• domainLinkColor

  The CSA colorDomainLink parameter.

  Declaration

  Objective-C

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

• textColor

  The CSA colorText parameter.

  Declaration

  Objective-C

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

• titleLinkColor

  The CSA colorTitleLink parameter.

  Declaration

  Objective-C

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

General Formatting

• adBorderCSSSelections

  The CSA adBorderSelections parameter.

  Declaration

  Objective-C

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

• adjustableLineHeight

  The CSA adjustableLineHeight parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat adjustableLineHeight;

• attributionBottomSpacing

  The CSA attributionSpacingBelow parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat attributionBottomSpacing;

• borderCSSSelections

  The CSA borderSelections parameter.

  Declaration

  Objective-C

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

• titleUnderlineHidden

  Indicates whether the CSA noTitleUnderline parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL titleUnderlineHidden;

• boldTitleEnabled

  Indicates whether the CSA titleBold parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL boldTitleEnabled;

• verticalSpacing

  The CSA verticalSpacing parameter.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) CGFloat verticalSpacing;

Ad Extensions

• detailedAttributionExtensionEnabled

  Indicates whether the CSA detailedAttribution parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic)
      BOOL detailedAttributionExtensionEnabled;

• longerHeadlinesExtensionEnabled

  Indicates whether the CSA longerHeadlines parameter is enabled.

  Declaration

  Objective-C

  @property (assign, readwrite, nonatomic) BOOL longerHeadlinesExtensionEnabled;

• -setAdvancedOptionValue:forKey:

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

  Declaration

  Objective-C

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