A SearchAdRequest contains targeting information used to fetch an ad from Search Ads for
Apps. Ad requests are created using SearchAdRequest.Builder.
Nested Class Summary
| class | SearchAdRequest.Builder | Builds a SearchAdRequest. |
|
Constant Summary
| int | BORDER_TYPE_DASHED | Dashed border. |
| int | BORDER_TYPE_DOTTED | Dotted border. |
| int | BORDER_TYPE_NONE | No border. |
| int | BORDER_TYPE_SOLID | Solid border. |
| int | CALL_BUTTON_COLOR_DARK | Dark-colored call button. |
| int | CALL_BUTTON_COLOR_LIGHT | Light-colored call button. |
| int | CALL_BUTTON_COLOR_MEDIUM | Medium-colored call button. |
| String | DEVICE_ID_EMULATOR | The deviceId for emulators to be used with
addTestDevice(String). |
| int | ERROR_CODE_INTERNAL_ERROR | Something happened internally; for instance, an invalid response was received from the ad server. |
| int | ERROR_CODE_INVALID_REQUEST | The ad request was invalid; for instance, the ad unit ID was incorrect. |
| int | ERROR_CODE_NETWORK_ERROR | The ad request was unsuccessful due to network connectivity. |
| int | ERROR_CODE_NO_FILL | The ad request was successful, but no ad was returned due to lack of ad inventory. |
Public Method Summary
| int |
getAnchorTextColor()
Returns the color of the ad URL.
|
| int |
getBackgroundColor()
Returns the background color of the ad.
|
| int |
getBackgroundGradientBottom()
Returns the color of the background gradient at the bottom of the ad.
|
| int |
getBackgroundGradientTop()
Returns the color of the background gradient at the top of the ad.
|
| int |
getBorderColor()
Returns the border color of the ad container.
|
| int |
getBorderThickness()
Returns the thickness of the border in pixels around the ad container.
|
| int |
getBorderType()
Returns the type of border around the ad container.
|
| int |
getCallButtonColor()
Returns the color of the call button when a call extension is shown.
|
| String |
getCustomChannels()
Returns the custom channels for the ad request.
|
| <T extends CustomEvent> Bundle |
getCustomEventExtrasBundle(Class<T> adapterClass)
Returns extra parameters to pass to a specific custom event adapter.
|
| int |
getDescriptionTextColor()
Returns the color of the ad description.
|
| String |
getFontFace()
Returns the font used to render the ad.
|
| int |
getHeaderTextColor()
Returns the font size of the header text in pixels.
|
| int |
getHeaderTextSize()
Returns the font size of the header text in pixels.
|
| Location |
getLocation()
Returns the user's location targeting information.
|
| <T extends NetworkExtras> T |
getNetworkExtras(Class<T> networkExtrasClass)
Returns extra parameters to pass to a specific ad network adapter.
|
| <T extends MediationAdapter> Bundle |
getNetworkExtrasBundle(Class<T> adapterClass)
Returns extra parameters to pass to a specific ad network adapter.
|
| String |
getQuery()
Returns the query of the search ad request.
|
| boolean |
Inherited Method Summary
Constants
public static final int BORDER_TYPE_DASHED
Dashed border.
public static final int BORDER_TYPE_DOTTED
Dotted border.
public static final int BORDER_TYPE_SOLID
Solid border.
public static final int CALL_BUTTON_COLOR_DARK
Dark-colored call button.
public static final int CALL_BUTTON_COLOR_LIGHT
Light-colored call button.
public static final int CALL_BUTTON_COLOR_MEDIUM
Medium-colored call button.
public static final String DEVICE_ID_EMULATOR
The deviceId for emulators to be used with
addTestDevice(String).
public static final int ERROR_CODE_INTERNAL_ERROR
Something happened internally; for instance, an invalid response was received from the ad server.
public static final int ERROR_CODE_INVALID_REQUEST
The ad request was invalid; for instance, the ad unit ID was incorrect.
public static final int ERROR_CODE_NETWORK_ERROR
The ad request was unsuccessful due to network connectivity.
public static final int ERROR_CODE_NO_FILL
The ad request was successful, but no ad was returned due to lack of ad inventory.
Public Methods
public int getBackgroundGradientBottom ()
Returns the color of the background gradient at the bottom of the ad.
public int getBackgroundGradientTop ()
Returns the color of the background gradient at the top of the ad.
public int getBorderColor ()
Returns the border color of the ad container.
public int getBorderThickness ()
Returns the thickness of the border in pixels around the ad container.
public int getBorderType ()
Returns the type of border around the ad container.
public int getCallButtonColor ()
Returns the color of the call button when a call extension is shown.
public String getCustomChannels ()
Returns the custom channels for the ad request. Custom channels allow publishers to track the performance of specific groups of ads. These custom channels need to created on the AdSense website. Reports can then be created based on the channels.