AppIndexApi | Android Developers

Quicknav Quicknav
Links

- Google Play Developer Console
- Android Developers Blog
- About Android

Android Sites

- Android.com
- Android Developers
- Android Open Source Project

Language
close

- - About
  - Wear
  - TV
  - Auto
- - Get Started
  - Devices
  - Style
  - Patterns
  - Building Blocks
  - Downloads
  - Videos
- - Training
  - API Guides
  - Reference
  - Tools
  - Google Services
  - Samples
- - Google Play
  - Essentials
  - Get Users
  - Engage & Retain
  - Monetize
  - Analyze
  - Tools & Reference
  - Developer Stories

## Results

Loading...
public interface

# AppIndexApi

com.google.android.gms.appindexing.AppIndexApi

## Class Overview

Provides methods for indexing actions that users are performing in your app to Google.

This API can be used to personalize users' Google Search experience based on usage of your app.

To use this API, add the following to your `Activity`:

     protected void onCreate(...) {
          mClient = new GoogleApiClient.Builder(getActivity())
              .addApi(AppIndex.API).build();
          ...
     }

     protected void onStart() {
         super.onStart();
         mClient.connect();
         Action viewAction = Action.newAction(Action.TYPE_VIEW, title, appUri);
         AppIndex.AppIndexApi.start(mClient, viewAction);
         ...
     }

     protected void onStop() {
      *  Action viewAction = Action.newAction(Action.TYPE_VIEW, title, appUri);
         AppIndex.AppIndexApi.end(mClient, viewAction);
         mClient.disconnect();
         super.onStop();
         ...
     }

## Summary

Nested Classes
interface | AppIndexApi.ActionResult | This interface is deprecated. Use `start(GoogleApiClient, Action)` and `end(GoogleApiClient, Action)`.
class | AppIndexApi.AppIndexingLink | An outbound link attached to viewed content.

Public Methods
abstract AppIndexApi.ActionResult | action(GoogleApiClient apiClient, Action action) This method is deprecated. Use `start(GoogleApiClient, Action)` instead.
abstract PendingResult<Status> | end(GoogleApiClient apiClient, Action action) Indicates that the user has ended a specific action in your app.
abstract PendingResult<Status> | start(GoogleApiClient apiClient, Action action) Indicates that the user has started a specific action in your app.
abstract PendingResult<Status> | view(GoogleApiClient apiClient, Activity activity, Intent viewIntent, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks) This method is deprecated. Use `start(GoogleApiClient, Action)` instead.
abstract PendingResult<Status> | view(GoogleApiClient apiClient, Activity activity, Uri appUri, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks) This method is deprecated. Use `start(GoogleApiClient, Action)` instead.
abstract PendingResult<Status> | viewEnd(GoogleApiClient apiClient, Activity activity, Uri appUri) This method is deprecated. Use `start(GoogleApiClient, Action)` instead.
abstract PendingResult<Status> | viewEnd(GoogleApiClient apiClient, Activity activity, Intent viewIntent) This method is deprecated. Use `end(GoogleApiClient, Action)` instead.

## Public Methods

#### public abstract AppIndexApi.ActionResult action (GoogleApiClient apiClient, Action action)

This method is deprecated.
Use `start(GoogleApiClient, Action)` instead.

#### public abstract PendingResult<Status> end (GoogleApiClient apiClient, Action action)

Indicates that the user has ended a specific action in your app.

This method should be called for instantaneous actions such as `TYPE_BOOKMARK`, `TYPE_LIKE`, `TYPE_WANT`.

##### Parameters

apiClient | The `GoogleApiClient` configured to use the `API`. The client should be connecting or connected.
action | The `Action` performed by the user within the app.

##### Returns

- The `PendingResult` which can optionally be used to determine if the call succeeded.

#### public abstract PendingResult<Status> start (GoogleApiClient apiClient, Action action)

Indicates that the user has started a specific action in your app.

##### Parameters

apiClient | The `GoogleApiClient` configured to use the `API`. The client should be connecting or connected.
action | The `Action` performed by the user within the app.

##### Returns

- The `PendingResult` which can optionally be used to determine if the call succeeded.

#### public abstract PendingResult<Status> view (GoogleApiClient apiClient, Activity activity, Intent viewIntent, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks)

This method is deprecated.
Use `start(GoogleApiClient, Action)` instead.

#### public abstract PendingResult<Status> view (GoogleApiClient apiClient, Activity activity, Uri appUri, String title, Uri webUrl, List<AppIndexApi.AppIndexingLink> outLinks)

This method is deprecated.
Use `start(GoogleApiClient, Action)` instead.

#### public abstract PendingResult<Status> viewEnd (GoogleApiClient apiClient, Activity activity, Uri appUri)

This method is deprecated.
Use `start(GoogleApiClient, Action)` instead.

#### public abstract PendingResult<Status> viewEnd (GoogleApiClient apiClient, Activity activity, Intent viewIntent)

This method is deprecated.
Use `end(GoogleApiClient, Action)` instead.