public final class

SearchAdView

extends ViewGroup
java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ com.google.android.gms.ads.search.SearchAdView

Class Overview

The View to display search banner ads for use with Search Ads for Apps. The ad size and ad unit ID must be set prior to calling loadAd(SearchAdRequest).

Sample code: 

 public class MyActivity extends Activity {
     private SearchAdView mSearchAdView;

     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);

         LinearLayout layout = new LinearLayout(this);
         layout.setOrientation(LinearLayout.VERTICAL);

         // Create a banner ad. The ad size and ad unit ID must be set before calling loadAd.
         mSearchAdView = new SearchAdView(this);
         mSearchAdView.setAdSize(AdSize.SMART_BANNER);
         mSearchAdView.setAdUnitId("myAdUnitId");

         // Create an ad request.
         SearchAdRequest.Builder searchAdRequestBuilder = new SearchAdRequest.Builder();

         // Optionally populate the ad request builder.
         searchAdRequestBuilder.addTestDevice(AdRequest.DEVICE_ID_EMULATOR);

         // Add the SearchAdView to the view hierarchy.
         layout.addView(mSearchAdView);

         // Start loading the ad.
         mSearchAdView.loadAd(searchAdRequestBuilder.build());

         setContentView(layout);
     }

     @Override
     public void onResume() {
         super.onResume();

         // Resume the SearchAdView.
         mSearchAdView.resume();
     }

     @Override
     public void onPause() {
         // Pause the SearchAdView.
         mSearchAdView.pause();

         super.onPause();
     }

     @Override
     public void onDestroy() {
         // Destroy the SearchAdView.
         mSearchAdView.destroy();

         super.onDestroy();
     }
 }

Summary

XML Attributes
Attribute Name Related Method Description
com.google.android.gms:adSize setAdSize(AdSize) The size of the ad. 
com.google.android.gms:adUnitId setAdUnitId(String) The ad unit ID. 
[Expand]
Inherited Constants
From class android.view.ViewGroup
From class android.view.View
[Expand]
Inherited Fields
From class android.view.View
Public Constructors
SearchAdView(Context context)
Construct a SearchAdView from code.
SearchAdView(Context context, AttributeSet attrs)
Construct a SearchAdView from an XML layout.
SearchAdView(Context context, AttributeSet attrs, int defStyle)
Construct a SearchAdView from an XML layout.
Public Methods
void destroy()
Destroy the SearchAdView.
AdListener getAdListener()
Returns the AdListener for this SearchAdView.
AdSize getAdSize()
Returns the size of the banner ad.
String getAdUnitId()
Returns the ad unit ID.
void loadAd(SearchAdRequest searchAdRequest)
Start loading the ad on a background thread.
void pause()
Pause any extra processing associated with this SearchAdView.
void resume()
Resume an SearchAdView after a previous call to pause().
void setAdListener(AdListener adListener)
Sets an AdListener for this SearchAdView.
void setAdSize(AdSize adSize)
Sets the size of the banner ad.
void setAdUnitId(String adUnitId)
Sets the ad unit ID.
Protected Methods
void onLayout(boolean changed, int left, int top, int right, int bottom)
void onMeasure(int widthMeasureSpec, int heightMeasureSpec)
[Expand]
Inherited Methods
From class android.view.ViewGroup
From class android.view.View
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.ViewManager
From interface android.view.ViewParent
From interface android.view.accessibility.AccessibilityEventSource

XML Attributes

com.google.android.gms:adSize

The size of the ad. It must be one of BANNER, FULL_BANNER, LEADERBOARD, MEDIUM_RECTANGLE, SMART_BANNER, WIDE_SKYSCRAPER, or <width>x<height>.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This is a private symbol.

Related Methods

com.google.android.gms:adUnitId

The ad unit ID.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This is a private symbol.

Related Methods

Public Constructors

public SearchAdView (Context context)

Construct a SearchAdView from code.

Parameters
context The Context the SearchAdView is running in.

public SearchAdView (Context context, AttributeSet attrs)

Construct a SearchAdView from an XML layout.

public SearchAdView (Context context, AttributeSet attrs, int defStyle)

Construct a SearchAdView from an XML layout.

Public Methods

public void destroy ()

Destroy the SearchAdView. This method should be called in the parent Activity's onDestroy() method. No other methods should be called on the SearchAdView after destroy() is called.

public AdListener getAdListener ()

Returns the AdListener for this SearchAdView.

public AdSize getAdSize ()

Returns the size of the banner ad. Returns null if setAdSize(AdSize) hasn't been called yet.

Related XML Attributes

public String getAdUnitId ()

Returns the ad unit ID.

Related XML Attributes

public void loadAd (SearchAdRequest searchAdRequest)

Start loading the ad on a background thread.

Throws
IllegalStateException If the size of the banner ad or the ad unit ID have not been set.

public void pause ()

Pause any extra processing associated with this SearchAdView. This method should be called in the parent Activity's onPause() method.

public void resume ()

Resume an SearchAdView after a previous call to pause(). This method should be called in the parent Activity's onResume() method.

public void setAdListener (AdListener adListener)

Sets an AdListener for this SearchAdView.

public void setAdSize (AdSize adSize)

Sets the size of the banner ad.

Related XML Attributes
Throws
IllegalStateException If the size of the banner ad was already set.

public void setAdUnitId (String adUnitId)

Sets the ad unit ID.

Related XML Attributes
Throws
IllegalStateException If the ad unit ID was already set.

Protected Methods

protected void onLayout (boolean changed, int left, int top, int right, int bottom)

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)