Google is committed to advancing racial equity for Black communities. See how.

SearchAdView

public final class SearchAdView extends ViewGroup

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(DynamicHeightSearchAdRequest).

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 search ad. The ad size and ad unit ID must be set before calling loadAd.
         mSearchAdView = new SearchAdView(this);
         mSearchAdView.setAdSize(AdSize.SEARCH);
         mSearchAdView.setAdUnitId("myAdUnitId");

         // Create an ad request.
         DynamicHeightSearchAdRequest.Builder builder =
             new DynamicHeightSearchAdRequest.Builder();

         // Set the query.
         builder.setQuery("flowers");

         // Optionally populate the ad request builder.
         builder.setAdTest(true);
         builder.setNumber(2);
         builder.setCssWidth(300);     // Equivalent to "width" CSA parameter.

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

         // Start loading the ad.
         mSearchAdView.loadAd(builder.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();
     }
 }

XML Attribute Summary

Inherited Constant Summary

Inherited Field Summary

Public Constructor Summary

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 Method Summary

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(DynamicHeightSearchAdRequest dynamicHeightSearchAdRequest)
Start loading the ad on a background thread.
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 Method Summary

void
onLayout(boolean changed, int left, int top, int right, int bottom)
void
onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Inherited Method Summary

XML Attributes

AdsAttrs_adSize

AdsAttrs_adUnitId

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

public String getAdUnitId ()

Returns the ad unit ID.

public void loadAd (DynamicHeightSearchAdRequest dynamicHeightSearchAdRequest)

Start loading the ad on a background thread.

Throws
IllegalStateException If the size of ad is anything other than AdSize.SEARCH, or the ad unit ID has not been set.

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 Activity.onPause() method.

public void resume ()

Resume an SearchAdView after a previous call to pause(). This method should be called in the parent Activity's Activity.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.

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

public void setAdUnitId (String adUnitId)

Sets the ad unit ID.

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)

Attribute Name
AdsAttrs_adSize
AdsAttrs_adUnitId