| commit | author | age | ||
| 96fe76 | 1 | // |
| L | 2 | // GADDynamicHeightSearchRequest.h |
| 3 | // GoogleMobileAds | |
| 4 | // | |
| 5 | // Copyright 2016 Google LLC. All rights reserved. | |
| 6 | // | |
| 7 | ||
| 8 | #import <GoogleMobileAds/GADRequest.h> | |
| 9 | ||
| 10 | /// Use to configure Custom Search Ad (CSA) ad requests. A dynamic height search banner can contain | |
| 11 | /// multiple ads and the height is set dynamically based on the ad contents. Cross-reference | |
| 12 | /// the property sections and properties with the official reference document: | |
| 13 | /// https://developers.google.com/custom-search-ads/docs/reference | |
| 14 | @interface GADDynamicHeightSearchRequest : GADRequest | |
| 15 | ||
| 16 | #pragma mark - Page Level Parameters | |
| 17 | ||
| 18 | #pragma mark Required | |
| 19 | ||
| 20 | /// The CSA "query" parameter. | |
| 21 | @property(nonatomic, copy, nullable) NSString *query; | |
| 22 | ||
| 23 | /// The CSA "adPage" parameter. | |
| 24 | @property(nonatomic, assign) NSInteger adPage; | |
| 25 | ||
| 26 | #pragma mark Configuration Settings | |
| 27 | ||
| 28 | /// Indicates whether the CSA "adTest" parameter is enabled. | |
| 29 | @property(nonatomic, assign) BOOL adTestEnabled; | |
| 30 | ||
| 31 | /// The CSA "channel" parameter. | |
| 32 | @property(nonatomic, copy, nullable) NSString *channel; | |
| 33 | ||
| 34 | /// The CSA "hl" parameter. | |
| 35 | @property(nonatomic, copy, nullable) NSString *hostLanguage; | |
| 36 | ||
| 37 | #pragma mark Layout and Styling | |
| 38 | ||
| 39 | /// The CSA "colorLocation" parameter. | |
| 40 | @property(nonatomic, copy, nullable) NSString *locationExtensionTextColor; | |
| 41 | ||
| 42 | /// The CSA "fontSizeLocation" parameter. | |
| 43 | @property(nonatomic, assign) CGFloat locationExtensionFontSize; | |
| 44 | ||
| 45 | #pragma mark Ad Extensions | |
| 46 | ||
| 47 | /// Indicates whether the CSA "clickToCall" parameter is enabled. | |
| 48 | @property(nonatomic, assign) BOOL clickToCallExtensionEnabled; | |
| 49 | ||
| 50 | /// Indicates whether the CSA "location" parameter is enabled. | |
| 51 | @property(nonatomic, assign) BOOL locationExtensionEnabled; | |
| 52 | ||
| 53 | /// Indicates whether the CSA "plusOnes" parameter is enabled. | |
| 54 | @property(nonatomic, assign) BOOL plusOnesExtensionEnabled; | |
| 55 | ||
| 56 | /// Indicates whether the CSA "sellerRatings" parameter is enabled. | |
| 57 | @property(nonatomic, assign) BOOL sellerRatingsExtensionEnabled; | |
| 58 | ||
| 59 | /// Indicates whether the CSA "siteLinks" parameter is enabled. | |
| 60 | @property(nonatomic, assign) BOOL siteLinksExtensionEnabled; | |
| 61 | ||
| 62 | #pragma mark - Unit Level Parameters | |
| 63 | ||
| 64 | #pragma mark Required | |
| 65 | ||
| 66 | /// The CSA "width" parameter. | |
| 67 | @property(nonatomic, copy, nullable) NSString *CSSWidth; | |
| 68 | ||
| 69 | /// Configuration Settings | |
| 70 | ||
| 71 | /// The CSA "number" parameter. | |
| 72 | @property(nonatomic, assign) NSInteger numberOfAds; | |
| 73 | ||
| 74 | #pragma mark Font | |
| 75 | ||
| 76 | /// The CSA "fontFamily" parameter. | |
| 77 | @property(nonatomic, copy, nullable) NSString *fontFamily; | |
| 78 | ||
| 79 | /// The CSA "fontFamilyAttribution" parameter. | |
| 80 | @property(nonatomic, copy, nullable) NSString *attributionFontFamily; | |
| 81 | ||
| 82 | /// The CSA "fontSizeAnnotation" parameter. | |
| 83 | @property(nonatomic, assign) CGFloat annotationFontSize; | |
| 84 | ||
| 85 | /// The CSA "fontSizeAttribution" parameter. | |
| 86 | @property(nonatomic, assign) CGFloat attributionFontSize; | |
| 87 | ||
| 88 | /// The CSA "fontSizeDescription" parameter. | |
| 89 | @property(nonatomic, assign) CGFloat descriptionFontSize; | |
| 90 | ||
| 91 | /// The CSA "fontSizeDomainLink" parameter. | |
| 92 | @property(nonatomic, assign) CGFloat domainLinkFontSize; | |
| 93 | ||
| 94 | /// The CSA "fontSizeTitle" parameter. | |
| 95 | @property(nonatomic, assign) CGFloat titleFontSize; | |
| 96 | ||
| 97 | #pragma mark Color | |
| 98 | ||
| 99 | /// The CSA "colorAdBorder" parameter. | |
| 100 | @property(nonatomic, copy, nullable) NSString *adBorderColor; | |
| 101 | ||
| 102 | /// The CSA "colorAdSeparator" parameter. | |
| 103 | @property(nonatomic, copy, nullable) NSString *adSeparatorColor; | |
| 104 | ||
| 105 | /// The CSA "colorAnnotation" parameter. | |
| 106 | @property(nonatomic, copy, nullable) NSString *annotationTextColor; | |
| 107 | ||
| 108 | /// The CSA "colorAttribution" parameter. | |
| 109 | @property(nonatomic, copy, nullable) NSString *attributionTextColor; | |
| 110 | ||
| 111 | /// The CSA "colorBackground" parameter. | |
| 112 | @property(nonatomic, copy, nullable) NSString *backgroundColor; | |
| 113 | ||
| 114 | /// The CSA "colorBorder" parameter. | |
| 115 | @property(nonatomic, copy, nullable) NSString *borderColor; | |
| 116 | ||
| 117 | /// The CSA "colorDomainLink" parameter. | |
| 118 | @property(nonatomic, copy, nullable) NSString *domainLinkColor; | |
| 119 | ||
| 120 | /// The CSA "colorText" parameter. | |
| 121 | @property(nonatomic, copy, nullable) NSString *textColor; | |
| 122 | ||
| 123 | /// The CSA "colorTitleLink" parameter. | |
| 124 | @property(nonatomic, copy, nullable) NSString *titleLinkColor; | |
| 125 | ||
| 126 | #pragma mark General Formatting | |
| 127 | ||
| 128 | /// The CSA "adBorderSelections" parameter. | |
| 129 | @property(nonatomic, copy, nullable) NSString *adBorderCSSSelections; | |
| 130 | ||
| 131 | /// The CSA "adjustableLineHeight" parameter. | |
| 132 | @property(nonatomic, assign) CGFloat adjustableLineHeight; | |
| 133 | ||
| 134 | /// The CSA "attributionSpacingBelow" parameter. | |
| 135 | @property(nonatomic, assign) CGFloat attributionBottomSpacing; | |
| 136 | ||
| 137 | /// The CSA "borderSelections" parameter. | |
| 138 | @property(nonatomic, copy, nullable) NSString *borderCSSSelections; | |
| 139 | ||
| 140 | /// Indicates whether the CSA "noTitleUnderline" parameter is enabled. | |
| 141 | @property(nonatomic, assign) BOOL titleUnderlineHidden; | |
| 142 | ||
| 143 | /// Indicates whether the CSA "titleBold" parameter is enabled. | |
| 144 | @property(nonatomic, assign) BOOL boldTitleEnabled; | |
| 145 | ||
| 146 | /// The CSA "verticalSpacing" parameter. | |
| 147 | @property(nonatomic, assign) CGFloat verticalSpacing; | |
| 148 | ||
| 149 | #pragma mark Ad Extensions | |
| 150 | ||
| 151 | /// Indicates whether the CSA "detailedAttribution" parameter is enabled. | |
| 152 | @property(nonatomic, assign) BOOL detailedAttributionExtensionEnabled; | |
| 153 | ||
| 154 | /// Indicates whether the CSA "longerHeadlines" parameter is enabled. | |
| 155 | @property(nonatomic, assign) BOOL longerHeadlinesExtensionEnabled; | |
| 156 | ||
| 157 | /// The CSA "styleId" parameter. | |
| 158 | @property(nonatomic, copy, nullable) NSString *styleID; | |
| 159 | ||
| 160 | /// Sets an advanced option value for a specified key. The value must be an NSString or NSNumber. | |
| 161 | - (void)setAdvancedOptionValue:(nonnull id)value forKey:(nonnull NSString *)key; | |
| 162 | ||
| 163 | @end | |
