When you want to make a connection to one of the Google APIs provided in the Google Play services
-library (such as Google+, Games, or Drive), you need to create an instance of {@code
-GoogleApiClient} ("Google API Client"). The Google API Client provides a common entry point to all
-the Google Play services and manages the network connection between the user's device and each
-Google service.
-
-
-
Connecting to REST APIs
-
If the Google API you want to use is not included in the Google Play services library, you can
-connect using the appropriate REST API, but you must obtain an OAuth 2.0 token. For more
-information, read Authorizing with Google
-for REST APIs.
-
-
-
This guide shows how you can use Google API Client to:
-
-
Connect to one or more Google Play services asynchronously and handle failures.
-
Perform synchronous and asynchronous API calls to any of the Google Play services.
-
-
-
-Note: If you have an existing app that connects to Google Play services with a
-subclass of {@code GooglePlayServicesClient}, you should migrate to {@code
-GoogleApiClient} as soon as possible.
-
-
-
-
-Figure 1. An illustration showing how the Google API Client provides an
-interface for connecting and making calls to any of the available Google Play services such as
-Google Play Games and Google Drive.
-
-
-
-
To get started, you must first install the Google Play services library (revision 15 or higher) for
-your Android SDK. If you haven't done so already, follow the instructions in Set Up Google
-Play Services SDK.
-
-
-
-
-
Start a Connection
-
-
Once your project is linked to the Google Play services library, create an instance of {@code
-GoogleApiClient} using the {@code
-GoogleApiClient.Builder} APIs in your activity's {@link
-android.app.Activity#onCreate onCreate()} method. The {@code
-GoogleApiClient.Builder} class
-provides methods that allow you to specify the Google APIs you want to use and your desired OAuth
-2.0 scopes. For example, here's a {@code
-GoogleApiClient} instance that connects with the Google
-Drive service:
-Important: If you are adding multiple APIs to a
-GoogleApiClient,
-you may run into client connection errors on devices that do not have the
-Android
-Wear app installed. To avoid connection errors, call the
-{@code addApiIfAvailable()}
-method and pass in the {@code
-Wearable} API to indicate that your client should gracefully handle the missing API.
-For more information, see Access the Wearable API.
For example, here's an activity that implements the callback interfaces and adds them to the Google
-API Client:
-
-
-import com.google.android.gms.common.api.GoogleApiClient;
-import com.google.android.gms.common.api.GoogleApiClient.ConnectionCallbacks;
-import com.google.android.gms.common.api.GoogleApiClient.OnConnectionFailedListener;
-import gms.drive.*;
-import android.support.v4.app.FragmentActivity;
-
-public class MyActivity extends FragmentActivity
- implements ConnectionCallbacks, OnConnectionFailedListener {
- private GoogleApiClient mGoogleApiClient;
-
- @Override
- protected void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
-
- // Create a GoogleApiClient instance
- mGoogleApiClient = new GoogleApiClient.Builder(this)
- .addApi(Drive.API)
- .addScope(Drive.SCOPE_FILE)
- .addConnectionCallbacks(this)
- .addOnConnectionFailedListener(this)
- .build();
- ...
- }
-
- @Override
- public void onConnected(Bundle connectionHint) {
- // Connected to Google Play services!
- // The good stuff goes here.
- }
-
- @Override
- public void onConnectionSuspended(int cause) {
- // The connection has been interrupted.
- // Disable any UI components that depend on Google APIs
- // until onConnected() is called.
- }
-
- @Override
- public void onConnectionFailed(ConnectionResult result) {
- // This callback is important for handling errors that
- // may occur while attempting to connect with Google.
- //
- // More about this in the next section.
- ...
- }
-}
-
-
-
With the callback interfaces defined, you're ready to call {@code connect()}. To gracefully manage
-the lifecycle of the connection, you should call {@code connect()} during the activity's {@link
-android.app.Activity#onStart onStart()} (unless you want to connect later), then call {@code disconnect()} during the {@link android.app.Activity#onStop onStop()} method. For example:
-
- @Override
- protected void onStart() {
- super.onStart();
- if (!mResolvingError) { // more about this later
- mGoogleApiClient.connect();
- }
- }
-
- @Override
- protected void onStop() {
- mGoogleApiClient.disconnect();
- super.onStop();
- }
-
-
-
However, if you run this code, there's a good chance it will fail and your app will receive a call
-to {@code onConnectionFailed()} with the {@code SIGN_IN_REQUIRED} error because the user account
-has not been specified. The next section shows how to handle this error and others.
If {@code hasResolution()} returns false, you should instead call {@code GooglePlayServicesUtil.getErrorDialog()}, passing it the error code. This returns a {@link
-android.app.Dialog} provided by Google Play services that's appropriate for the given error. The
-dialog may simply provide a message explaining the error, but it may also provide an action to
-launch an activity that can resolve the error (such as when the user needs to install a newer
-version of Google Play services).
-public class MyActivity extends FragmentActivity
- implements ConnectionCallbacks, OnConnectionFailedListener {
-
- // Request code to use when launching the resolution activity
- private static final int REQUEST_RESOLVE_ERROR = 1001;
- // Unique tag for the error dialog fragment
- private static final String DIALOG_ERROR = "dialog_error";
- // Bool to track whether the app is already resolving an error
- private boolean mResolvingError = false;
-
- ...
-
- @Override
- public void onConnectionFailed(ConnectionResult result) {
- if (mResolvingError) {
- // Already attempting to resolve an error.
- return;
- } else if (result.hasResolution()) {
- try {
- mResolvingError = true;
- result.startResolutionForResult(this, REQUEST_RESOLVE_ERROR);
- } catch (SendIntentException e) {
- // There was an error with the resolution intent. Try again.
- mGoogleApiClient.connect();
- }
- } else {
- // Show dialog using GooglePlayServicesUtil.getErrorDialog()
- showErrorDialog(result.getErrorCode());
- mResolvingError = true;
- }
- }
-
- // The rest of this code is all about building the error dialog
-
- /* Creates a dialog for an error message */
- private void showErrorDialog(int errorCode) {
- // Create a fragment for the error dialog
- ErrorDialogFragment dialogFragment = new ErrorDialogFragment();
- // Pass the error that should be displayed
- Bundle args = new Bundle();
- args.putInt(DIALOG_ERROR, errorCode);
- dialogFragment.setArguments(args);
- dialogFragment.show(getSupportFragmentManager(), "errordialog");
- }
-
- /* Called from ErrorDialogFragment when the dialog is dismissed. */
- public void onDialogDismissed() {
- mResolvingError = false;
- }
-
- /* A fragment to display an error dialog */
- public static class ErrorDialogFragment extends DialogFragment {
- public ErrorDialogFragment() { }
-
- @Override
- public Dialog onCreateDialog(Bundle savedInstanceState) {
- // Get the error code and retrieve the appropriate dialog
- int errorCode = this.getArguments().getInt(DIALOG_ERROR);
- return GooglePlayServicesUtil.getErrorDialog(errorCode,
- this.getActivity(), REQUEST_RESOLVE_ERROR);
- }
-
- @Override
- public void onDismiss(DialogInterface dialog) {
- ((MainActivity)getActivity()).onDialogDismissed();
- }
- }
-}
-
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
- if (requestCode == REQUEST_RESOLVE_ERROR) {
- mResolvingError = false;
- if (resultCode == RESULT_OK) {
- // Make sure the app is not already connected or attempting to connect
- if (!mGoogleApiClient.isConnecting() &&
- !mGoogleApiClient.isConnected()) {
- mGoogleApiClient.connect();
- }
- }
- }
-}
-
-
-
In the above code, you probably noticed the boolean, {@code mResolvingError}. This keeps track of
-the app state while the user is resolving the error to avoid repetitive attempts to resolve the
-same error. For instance, while the account picker dialog is showing to resolve the {@code SIGN_IN_REQUIRED} error, the user may rotate the screen. This recreates your activity and causes
-your {@link android.app.Activity#onStart onStart()} method to be called again, which then calls {@code connect()} again. This results in another call to {@code startResolutionForResult()}, which
-creates another account picker dialog in front of the existing one.
-
-
This boolean is effective only
-if retained across activity instances, though. The next section explains further.
-
-
-
-
Maintain state while resolving an error
-
-
To avoid executing the code in
-
-{@code onConnectionFailed()} while a previous attempt to resolve an
-error is ongoing, you need to retain a boolean that tracks whether your app is already attempting
-to resolve an error.
-
-
As shown in the code above, you should set a boolean to {@code true} each time you call {@code startResolutionForResult()} or display the dialog from {@code GooglePlayServicesUtil.getErrorDialog()}. Then when you
-receive {@link android.app.Activity#RESULT_OK} in the {@link android.app.Activity#onActivityResult
-onActivityResult()} callback, set the boolean to {@code false}.
-
-
To keep track of the boolean across activity restarts (such as when the user rotates the screen),
-save the boolean in the activity's saved instance data using {@link
-android.app.Activity#onSaveInstanceState onSaveInstanceState()}:
Now you're ready to safely run your app and connect to Google Play services.
-How you can perform read and write requests to any of the Google Play services
-using {@code
-GoogleApiClient} is discussed in the next section.
-
-
For more information about each services's APIs available once you're connected,
-consult the corresponding documentation, such as for
-Google Play Games or
-Google Drive.
-
-
-
-
Access the Wearable API
-
-
The Wearable API provides a communication channel for your handheld and wearable apps. The API
-consists of a set of data objects that the system can send and synchronize over the wire and
-listeners that notify your apps of important events with the data layer. The
-{@code Wearable}
-API is available on devices running Android 4.3 (API level 18) or higher when a wearable device is
-connected. The API is not available under the following conditions:
-
-
-
-
Devices running Android 4.2 (API level 17) or earlier.
-The following example shows how to determine whether the
-{@code Wearable}
-API is available:
-
-
-
-// Connection failed listener method for a client that only
-// requests access to the Wearable API
-@Override
-public void onConnectionFailed(ConnectionResult result) {
- if (result.getErrorCode() == ConnectionResult.API_UNAVAILABLE) {
- // The Wearable API is unavailable
- }
- ...
-}
-
-
-
-
Using the Wearable API with other APIs
-
-
-If your app uses the
-{@code Wearable}
-API in addition to other Google APIs, call the
-addApiIfAvailable()
-method and pass in the
-{@code Wearable}
-API to indicate that your client should gracefully handle the missing API.
In the example above, the
-{@code GoogleApiClient}
-can successfully connect with the Google Drive service without connecting to the
-{@code Wearable}
-API if it is unavailable. After you connect your
-{@code GoogleApiClient}
-instance, ensure that the
-{@code Wearable}
-API is available before making the API calls:
-
Once connected, your client can make read and write calls using the service-specific APIs for which
-your app is authorized, as specified by the APIs and scopes you added to your {@code
-GoogleApiClient} instance.
-
-
-Note: Before making calls to specific Google services, you may first need to
-register your app in the Google Developer Console. For specific instructions, refer to the
-appropriate getting started guide for the API you're using, such as Google Drive or Google+.
-
-
When you perform a read or write request using Google API Client, the immediate result is returned
-as a {@code
-PendingResult} object. This is an object representing the request, which hasn't yet
-been delivered to the Google service.
-
-
For example, here's a request to read a file from Google Drive that provides a
-{@code
-PendingResult} object:
-
-
-Query query = new Query.Builder()
- .addFilter(Filters.eq(SearchableField.TITLE, filename));
-PendingResult result = Drive.DriveApi.query(mGoogleApiClient, query);
-
-
-
Once you have the
-{@code
-PendingResult}, you can continue by making the request either asynchronous
-or synchronous.
If you want your code to execute in a strictly defined order, perhaps because the result of one
-call is needed as an argument to another, you can make your request synchronous by calling {@code await()} on the
-{@code
-PendingResult}. This blocks the thread and returns the {@code Result} object
-when the request completes, which is delivered as an instance of the
-appropriate subclass as specified by the API you're using, such as {@code DriveApi.MetadataBufferResult}.
-
-
Because calling {@code await()} blocks the thread until the result arrives, it's important that you
-never perform this call on the UI thread. So, if you want to perform synchronous requests to a
-Google Play service, you should create a new thread, such as with {@link android.os.AsyncTask} in
-which to perform the request. For example, here's how to perform the same file request to Google
-Drive as a synchronous call:
-Tip: You can also enqueue read requests while not connected to Google Play
-services. For example, execute a method to read a file from Google Drive regardless of whether your
-Google API Client is connected yet. Then once a connection is established, the read requests
-execute and you'll receive the results. Any write requests, however, will generate an error if you
-call them while your Google API Client is not connected.
-
diff --git a/docs/html/google/auth/http-auth.jd b/docs/html/google/auth/http-auth.jd
deleted file mode 100644
index 7d34d89d04bd4ff225cdf8b8ef61203796fdc581..0000000000000000000000000000000000000000
--- a/docs/html/google/auth/http-auth.jd
+++ /dev/null
@@ -1,558 +0,0 @@
-page.title=Authorizing with Google for REST APIs
-page.tags="oauth 2.0","GoogleAuthUtil"
-
-trainingnavtop=true
-startpage=true
-
-@jd:body
-
-
-
When you want your Android app to access Google APIs using the user's Google account over
-HTTP, the {@code GoogleAuthUtil}
-class and related APIs provide your users a secure and consistent experience for picking an
-account and retrieving an OAuth 2.0 token for your app.
-
-
You can then use that token in your HTTP-based communications with Google API services
-that are not included in the Google Play
-services library, such as the Blogger or Translate APIs.
-
-
Note: An OAuth 2.0 token using {@code GoogleAuthUtil}
-is required only for certain types of Google
-APIs that you need to access over HTTP. If you're instead using the Google Play services library to access Google
-APIs such as Google+ or Play Games, you don't need an OAuth 2.0
-token and you can instead access these services using the {@code GoogleApiClient}. For more
-information, read Accessing Google Play
-Services APIs.
-
-
To get started with {@code GoogleAuthUtil}
-for accessing Google's REST APIs, you must set up your Android app project with the Google Play
-services library. Follow the procedures in Setup Google Play Services SDK.
-
-
-
-
-
Register Your App
-
-
Before you can publish an app that retrieves an OAuth 2.0 token for Google REST APIs,
-you must register your Android app with the Google Cloud Console by providing your app's
-package name and the SHA1 fingerprint of the keystore with which you sign your release APK.
-
-
Caution: While you are testing an APK that's signed with a
-debug key, Google does not require that your app be registered in Google Cloud Console. However,
-your app must be registered in Google Cloud Console in order to continue working once it is
-signed
-with a release key.
-
-
To register your Android app with Google Cloud Console:
If you have an existing project to which you're adding an Android app, select the project.
-Otherwise, click Create project at the top, enter your project name and ID,
-then click Create.
-
Note: The name you provide for the project is the name that
-appears to users in the Google Settings app in the list of Connected apps.
-
In the left-side navigation, select APIs & auth.
-
Enable the API you'd like to use by setting the Status to ON.
-
-
In the left-side navigation, select Credentials.
-
Click Create new client ID or Create new key
-as appropriate for your app.
-
Complete the form that appears by filling in your Android app details.
-
To get the SHA1 fingerprint for your app, run the following command in a terminal:
-
The Credentials page then provides the available credentials such as an OAuth 2.0 client ID and
-an Android Key, but you don't need these to authorize your Android users. Simply registering your
-app with the package name and SHA1 makes the Google services accessible by your app.
-
-
-
To acquire the OAuth 2.0 token that will grant you access to Google APIs over HTTP, you need to
-first identify the user's Google account with which you'll query the servers. For this task, the
-Google Play services library provides a convenient account picker dialog you can invoke using
-{@code
-AccountPicker}. The result delivered to your activity from the account picker is the account
-name you'll use to request the OAuth 2.0 token in the next lesson.
-
-
Note: In order to use the APIs discussed here, you must
-include the Google Play services library with your project. If you haven't set up your project
-with the library yet, read the guide to Setup Google Play Services SDK.
-
-
-
-
Invoke the Account Picker
-
-
To open the account picker dialog that's managed by the Google Play services library, call
-{@link android.app.Activity#startActivityForResult startActivityForResult()} using an {@link
-android.content.Intent} returned by
-{@code AccountPicker.newChooseAccountIntent}.
When this code executes, a dialog appears for the user to pick an account. When the user
-selects the account, your activity receives the result in the {@link
-android.app.Activity#onActivityResult onActivityResult()} callback.
The dialog should list only accounts from the "com.google" domain.
-
Don't prompt the user to pick an account if there's only one available account (just use that
-one). However, even if only one account currently exists, the dialog may include an option for the
-user to add a new account.
-
There is no custom title for the dialog.
-
There is no specific auth token type required.
-
There are no restrictions based on account features.
Once the user selects an account, your activity receives a call to its
-{@link android.app.Activity#onActivityResult onActivityResult()} method. The received
-{@link android.content.Intent} includes an extra for
-{@link android.accounts.AccountManager#KEY_ACCOUNT_NAME}, specifying the account name
-(an email address) you must use to acquire the OAuth 2.0 token.
-
-
Here's an example implementation of the callback {@link android.app.Activity#onActivityResult
-onActivityResult()} that receives the selected account:
-
-
-String mEmail; // Received from {@code newChooseAccountIntent()}; passed to {@code getToken()}
-
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
- if (requestCode == REQUEST_CODE_PICK_ACCOUNT) {
- // Receiving a result from the AccountPicker
- if (resultCode == RESULT_OK) {
- mEmail = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
- // With the account name acquired, go get the auth token
- getUsername();
- } else if (resultCode == RESULT_CANCELED) {
- // The account picker dialog closed without selecting an account.
- // Notify users that they must pick an account to proceed.
- Toast.makeText(this, R.string.pick_account, Toast.LENGTH_SHORT).show();
- }
- }
- // Later, more code will go here to handle the result from some exceptions...
-}
-
-
-
You can now pass the account name held by {@code mEmail} to
-{@code GoogleAuthUtil.getToken()} (which is what the {@code getUsername()} method
-does), but because it performs network transactions, this method should not be called from the
-UI thread. The next lesson shows how to create an {@link android.os.AsyncTask} to get the auth token
-on a separate thread.
-
-
-
Once you have retrieved the account name for the user's Google account, you can call
-{@code GoogleAuthUtil.getToken()}, which returns the access token string required by Google API
-services.
-
-
-
Calling this method is generally a straightforward procedure, but you must be
-aware that:
-
-
The
-{@code GoogleAuthUtil.getToken()} method requires a network connection, so your app must
-acquire the {@link android.Manifest.permission#INTERNET} permission. You should also check whether
-the device has a network connection at runtime by querying {@link android.net.NetworkInfo}, which
-requires that your app also acquire the {@link android.Manifest.permission#ACCESS_NETWORK_STATE}
-permissions—for more details, read Connecting to the Network.
-
Because the
-{@code GoogleAuthUtil.getToken()} method performs a synchronous network transaction, you should
-always perform this call from a worker thread to avoid blocking your app's UI thread.
This lesson shows how you can gracefully handle these concerns by performing authentication in
-an {@link android.os.AsyncTask} and providing users with the appropriate information and available
-actions during known exceptions.
-
-
Note: The code shown in this lesson, using {@code GoogleAuthUtil.getToken()},
-is appropriate when you will be requesting the OAuth token from an {@link android.app.Activity}.
-However, if you need to request the OAuth token from a {@link android.app.Service}, then you
-should instead use {@code
-getTokenWithNotification()}. This method works the same as {@code GoogleAuthUtil.getToken()}, but if an error occurs, it
-also creates an appropriate
-notification
-that allows the user can recover from the error.
-The sample available for download above includes code showing how to use this method instead.
-
-
-
Extend AsyncTask to Get the Auth Token
-
-
The {@link android.os.AsyncTask} class provides a simple way to create a worker thread for jobs
-that should not run on your UI thread. This lesson focuses on how to create such a thread
-to get your auth token; for a more complete discussion about {@link android.os.AsyncTask},
-read Keeping Your
-App Responsive and the {@link android.os.AsyncTask} class reference.
-
-
-
The {@link android.os.AsyncTask#doInBackground doInBackground()} method in your {@link
-android.os.AsyncTask} class is where you should call the
-{@code GoogleAuthUtil.getToken()} method. You can also use it to catch some of the generic
-exceptions that may occur during your network transactions.
-public class GetUsernameTask extends AsyncTask{
- Activity mActivity;
- String mScope;
- String mEmail;
-
- GetUsernameTask(Activity activity, String name, String scope) {
- this.mActivity = activity;
- this.mScope = scope;
- this.mEmail = name;
- }
-
- /**
- * Executes the asynchronous job. This runs when you call execute()
- * on the AsyncTask instance.
- */
- @Override
- protected Void doInBackground(Void... params) {
- try {
- String token = fetchToken();
- if (token != null) {
- // Insert the good stuff here.
- // Use the token to access the user's Google data.
- ...
- }
- } catch (IOException e) {
- // The fetchToken() method handles Google-specific exceptions,
- // so this indicates something went wrong at a higher level.
- // TIP: Check for network connectivity before starting the AsyncTask.
- ...
- }
- return null;
- }
-
- /**
- * Gets an authentication token from Google and handles any
- * GoogleAuthException that may occur.
- */
- protected String fetchToken() throws IOException {
- try {
- return GoogleAuthUtil.getToken(mActivity, mEmail, mScope);
- } catch (UserRecoverableAuthException userRecoverableException) {
- // GooglePlayServices.apk is either old, disabled, or not present
- // so we need to show the user some UI in the activity to recover.
- mActivity.handleException(userRecoverableException);
- } catch (GoogleAuthException fatalException) {
- // Some other type of unrecoverable exception has occurred.
- // Report and log the error as appropriate for your app.
- ...
- }
- return null;
- }
- ...
-}
-
-
-
In order to call
-{@code GoogleAuthUtil.getToken()}, you must provide the app {@link android.content.Context},
-the account name retrieved from the account picker, and the scope for your auth
-token request. The above sample code (and the attached sample) defines these
-arguments with class members that the host activity passes to the {@link android.os.AsyncTask} class constructor. For more information about setting the scope, see
-the Specifying Scopes section below.
-
-
Note:
-As shown by the {@code fetchToken()} method above, you must handle
-special exceptions that may occur during the
-{@code GoogleAuthUtil.getToken()} method. The next section shows how you should
-respond to these exceptions.
-
-
Once you have an {@link android.os.AsyncTask} subclass defined,
-you can instantiate and execute an instance after you get the user's
-account name from the account picker.
-For example, back in the {@link android.app.Activity} class you can do something like this:
-
-
-String mEmail; // Received from {@code newChooseAccountIntent()}; passed to {@code getToken()}
-private static final String SCOPE =
- "oauth2:https://www.googleapis.com/auth/userinfo.profile";
-
-/**
- * Attempts to retrieve the username.
- * If the account is not yet known, invoke the picker. Once the account is known,
- * start an instance of the AsyncTask to get the auth token and do work with it.
- */
-private void getUsername() {
- if (mEmail == null) {
- pickUserAccount();
- } else {
- if (isDeviceOnline()) {
- new GetUsernameTask(HelloActivity.this, mEmail, SCOPE).execute();
- } else {
- Toast.makeText(this, R.string.not_online, Toast.LENGTH_LONG).show();
- }
- }
-}
-
For information about how to check whether the device is currently online (as performed by
-the {@code isDeviceOnline()} method above), see the attached sample app or the
-Connecting to the Network lesson.
The scope string is used to specify which Google services can be accessed by
- an app using the requested auth token. An auth token can be associated with
- multiple scopes.
-
When specifying the scopes in your auth token request, prefix the
- scope string with {@code "oauth2:"} followed by a list of one or more OAuth scope
- values. Use a space to separate each scope value in the list. To see a list of
- valid OAuth scope values for Google services, browse
- the OAuth 2.0 Playground.
-
Tip: Specify {@code "oauth2:<scope>"}
- for a single scope. Specify
- {@code "oauth2:<scope1> <scope2> <scopeN>"} for multiple
- scopes (using a space to separate each scope).
-
For example, to access the Google Books API, the scope is
- {@code "oauth2:https://www.googleapis.com/auth/books"}. To add an additional
- scope, say for Google+ login, your code might look like this:
To provide users information and a proper solution to issues that may occur while acquiring the
-auth token, it's important that you properly handle the following subclasses of {@code
-GoogleAuthException}:
This is an error that users can resolve through some verification. For example, users may
- need to confirm that your app is allowed to access their Google data or they may need to re-enter
- their account password. When you receive this exception, call {@code
-getIntent()} on the instance and pass the returned {@link android.content.Intent} to {@link
-android.app.Activity#startActivityForResult startActivityForResult()} to give users the opportunity
-to solve the problem, such as by logging in.
This is a specific type of {@code
- UserRecoverableAuthException} indicating that the user's current version
-of Google Play services is outdated. Although the recommendation above for
-{@code
- UserRecoverableAuthException} also works for this exception, calling {@link
-android.app.Activity#startActivityForResult startActivityForResult()} will immediately send users
- to Google Play Store to install an update, which may be confusing. So you should instead call
-{@code getConnectionStatusCode()} and pass the result to
-{@code GooglePlayServicesUtil.getErrorDialog()}. This returns a {@link android.app.Dialog}
-that includes an appropriate message and a button to take users to Google Play Store so they
-can install an update.
-
-
-
For example, the fetchToken() method in the above sample code catches any
-occurrence of {@code
-UserRecoverableAuthException} and passes it back to the activity with a method called
-{@code handleException()}. Here's what that method in the activity may look like:
-
-
-
-static final int REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR = 1001;
-
-/**
- * This method is a hook for background threads and async tasks that need to
- * provide the user a response UI when an exception occurs.
- */
-public void handleException(final Exception e) {
- // Because this call comes from the AsyncTask, we must ensure that the following
- // code instead executes on the UI thread.
- runOnUiThread(new Runnable() {
- @Override
- public void run() {
- if (e instanceof GooglePlayServicesAvailabilityException) {
- // The Google Play services APK is old, disabled, or not present.
- // Show a dialog created by Google Play services that allows
- // the user to update the APK
- int statusCode = ((GooglePlayServicesAvailabilityException)e)
- .getConnectionStatusCode();
- Dialog dialog = GooglePlayServicesUtil.getErrorDialog(statusCode,
- HelloActivity.this,
- REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR);
- dialog.show();
- } else if (e instanceof UserRecoverableAuthException) {
- // Unable to authenticate, such as when the user has not yet granted
- // the app access to the account, but the user can fix this.
- // Forward the user to an activity in Google Play services.
- Intent intent = ((UserRecoverableAuthException)e).getIntent();
- startActivityForResult(intent,
- REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR);
- }
- }
- });
-}
-
-
-
Notice that in both cases, the {@code REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR}
-request code is passed with the request to handle the exception with a dialog or activity.
-This way, when the user completes the appropriate action to resolve the exception,
-your {@link android.app.Activity#onActivityResult onActivityResult()} method receives an
-intent that includes this request code and you can try to acquire the auth
-token again.
-
-
-
For example, the following code is a complete implementation of {@link
-android.app.Activity#onActivityResult onActivityResult()} that handles results for
-both the {@code REQUEST_CODE_PICK_ACCOUNT} action (shown in the previous lesson, Picking the User's Account)
-and the {@code REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR} action, which occurs after the user
-completes one of the actions above to resolve an exception.
-
-
-
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
- if (requestCode == REQUEST_CODE_PICK_ACCOUNT) {
- // Receiving a result from the AccountPicker
- if (resultCode == RESULT_OK) {
- mEmail = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
- // With the account name acquired, go get the auth token
- getUsername();
- } else if (resultCode == RESULT_CANCELED) {
- // The account picker dialog closed without selecting an account.
- // Notify users that they must pick an account to proceed.
- Toast.makeText(this, R.string.pick_account, Toast.LENGTH_SHORT).show();
- }
- } else if ((requestCode == REQUEST_CODE_RECOVER_FROM_AUTH_ERROR ||
- requestCode == REQUEST_CODE_RECOVER_FROM_PLAY_SERVICES_ERROR)
- && resultCode == RESULT_OK) {
- // Receiving a result that follows a GoogleAuthException, try auth again
- getUsername();
- }
-}
-
-
-
For a complete set of code that acquires the OAuth token and queries a Google service
-over HTTP (including how to use {@code
-getTokenWithNotification()} when you need to acquire the token from
-a {@link android.app.Service}), see the sample app available for download at the top
-of this page.
- Google Play services offers a standard authorization flow for all Google APIs and
- all components of Google Play services. In addition, you can leverage the authorization
- portion of the Google Play services SDK to gain authorization to services that are not yet supported
- in the Google Play services platform by using the access token to manually make API
- requests or using a client library provided by the service provider.
-
-
-
For implementation details, see the sample in <android-sdk>/extras/google-play-services/samples/auth,
-which shows you how to carry out these basic steps for obtaining an access token.
-
-
Choosing an Account
-
- Google Play services leverage existing accounts on an Android-powered device
- to gain authorization to the services that you want to use. To obtain an access token,
- a valid Google account is required and it must exist on the device. You can ask your users which
- account they want to use by enumerating the Google accounts on the device or using the
- built-in
-{@code
-AccountPicker}
- class to display a standard account picker view. You'll need the
- {@link android.Manifest.permission#GET_ACCOUNTS}
- permission set in your manifest file for both methods.
-
-
- For example, here's how to gather all of the Google accounts on a device and return them
- in an array. When obtaining an access token, only the email address of the account is
- needed, so that is what the array stores:
-
- With an email address and the service scope you can now obtain an access token.
-
-
Note: Specify "oauth2:scope" for a single scope or
- "oauth2:scope1scope2scope3" for multiple scopes.
-
-There are two general
- ways to get a token:
-
-
-
Call one of the two overloaded {@code GoogleAuthUtil.getToken()} methods in a foreground activity where you can
- display a dialog to the user to interactively handle authorization errors.
-
Call one of the three {@code getTokenWithNotification()}
- methods if you are trying to gain authorization in a background service or sync adapter so that a
- notification is displayed if an error occurs.
-
-
-
Using getToken()
- The following code snippet obtains an access token with an email address, the scope that you want to use for the service, and a {@link android.content.Context}:
-
-
Call this method off of the main UI thread since it executes network transactions. An easy way to do this
- is in an {@link android.os.AsyncTask}.
- The sample in the Google Play services SDK shows you how to wrap this call in an AsyncTask.
- If authorization is successful, the token is returned. If not, the exceptions described in
-Handling Exceptions
- are thrown that you can catch and handle appropriately.
-
-
-
Using getTokenWithNotification()
-
If you are obtaining access tokens in a background service or sync adapter, there
- are three overloaded
- {@code getTokenWithNotification()} methods
- that you can use:
Create a {@link android.content.BroadcastReceiver} that registers the intent and handles
-it appropriately
-
In the app's manifest file, set the android:exported
- attribute to true for the broadcast receiver
-
Ensure that the intent is serializable using the {@link
-android.content.Intent#toUri toUri(Intent.URI_INTENT_SCHEME)} and
- {@link android.content.Intent#parseUri parseUri(intentUri, Intent.URI_INTENT_SCHEME)} methods.
-{@code UserRecoverableAuthException}:
- This exception is thrown when an error occurs that users can resolve, such as not yet granting access to their accounts or if they changed their password.
- This exception class contains a {@link android.app.Activity#getIntent getIntent()}
- method that you can call to obtain an intent that you can use with
-{@link android.app.Activity#startActivityForResult startActivityForResult()}
- to obtain the user's resolution. You will need to handle the
-{@link android.app.Activity#onActivityResult onActivityResult()}
- callback when this activity returns to take action based on the user's actions.
-
-
-{@code GooglePlayServicesAvailabilityException}:
- This exception is a special case of {@code UserRecoverableAuthException}
- and occurs when the actual Google Play services APK is not installed or unavailable.
- This exception provides additional client support to
- handle and fix this issue by providing an error code that describes the exact cause of the problem.
- This exception also contains an intent that you can obtain and use to start
- an activity to resolve the issue.
-
-
-{@code
-GoogleAuthException}:
- This exception is thrown when the authorization fails, such as when an invalid scope is
- specified or if the email address used for authorization is actually not on the user's
- device.
-
- For more information on how to handle these exceptions and code snippets, see the reference
- documentation for the
-{@code
-GoogleAuthUtil} class.
-
-
-
-
-
-
Using the Access Token
-
- Once you have successfully obtained a token, you can use it to access Google services.
- Many Google services provide client libraries, so it is recommended that you use these when
- possible, but you can make raw HTTP requests as well with the token. The following example
- shows you how to do this and handle HTTP error and success responses accordingly:
-
-
-
-URL url = new URL("https://www.googleapis.com/oauth2/v1/userinfo?access_token="
- + token);
-HttpURLConnection con = (HttpURLConnection) url.openConnection();
-int serverCode = con.getResponseCode();
-//successful query
-if (serverCode == 200) {
- InputStream is = con.getInputStream();
- String name = getFirstName(readResponse(is));
- mActivity.show("Hello " + name + "!");
- is.close();
- return;
-//bad token, invalidate and get a new one
-} else if (serverCode == 401) {
- GoogleAuthUtil.invalidateToken(mActivity, token);
- onError("Server auth error, please try again.", null);
- Log.e(TAG, "Server auth error: " + readResponse(con.getErrorStream()));
- return;
-//unknown error, do something else
-} else {
- Log.e("Server returned the following error code: " + serverCode, null);
- return;
-}
-
-
-
- Notice that you must manually invalidate the token if the response from the server
- signifies an authorization error (401). This could mean the access token
- being used is invalid for the service's scope or the token may have expired. If this is the
- case, obtain a new token using {@code GoogleAuthUtil.getToken()}.
-
diff --git a/docs/html/google/play-services/index.jd b/docs/html/google/play-services/index.jd
deleted file mode 100644
index 11060e8448e44077b02c808b08c0c4fbd3ebe21c..0000000000000000000000000000000000000000
--- a/docs/html/google/play-services/index.jd
+++ /dev/null
@@ -1,706 +0,0 @@
-page.title=Google Play Services
-header.hide=1
-page.metaDescription=With Google Play services, your app can take advantage of the latest Google-powered features such as Maps, Analytics, and more: platform updates are distributed automatically as an APK through the Google Play Store.
-
-@jd:body
-
-
-
-
-
-
-
-
-
Google Play Services
-
Give your apps more features to attract users
- on a wider range of devices.
- With Google Play services, your app can take advantage
- of the latest, Google-powered features such as Maps, Google+, and more,
- with automatic platform updates distributed as an APK through
- the Google Play store. This makes it faster for your users to receive updates
- and easier for you to integrate the newest that Google has to offer.
-
-
-
-
-
-
-
-
-
Google Technology
-
Google Play services provides you with easy access to Google services and is
-tightly integrated with the Android OS. Easy-to-use client libraries are
-provided for each service that let you implement the functionality you want
-easier and faster.
-
-
-
-
-
Standard Authorization
-
All products in Google Play services share a common authorization API
- that leverages the existing Google accounts on the device. You and your
- users have a consistent and safe way to grant and receive OAuth2 access tokens
- to Google services.
-
-
-
-
-
Automatic Updates
-
Devices running Android 2.3 or higher that have the Google Play Store
-app will automatically receive updates to Google Play services. Enhance
-your app with the most recent version of Google Play services without worrying
-about your users' Android version.
-
-
-
To start integrating Google Play services into your app,
- follow the Setup guide.
For a summary of the feature highlights in Google Play services 7.3, see the
-announcement
-blog post.
-
-
- Wear - This release provides you with the ability
-to advertise and discover the capabilities of devices that are connected in a Wear network, through
-the new
-{@code CapabilityApi} class. The new
-{@code ChannelApi}
-class lets you send and receive data bi-directionally from your wearable app on a device to another
-wearable node. Use the Channel API to send large files for offline access or to stream real-time
-binary data.
-
- Fit - This release provides a new
-
-{@code HistoryApi.readDailyTotal()} method for you to get aggregated daily data for a given
-data type.
-This release also introduces data types for recording granular nutrition information including
-protein, fat, cholesterol, and more.
-
- Location - This release adds a maximum wait time for location updates. By
-calling the new
-
-{@code setMaxWaitTime()} method and passing in a value at least double the value requested with
-the
-
-{@code setInterval()} method, the system can batch location updates together, reducing battery
-usage and, on some devices, improving location accuracy. In addition, you can use the new
-
-{@code LocationCallback} class to be notified when the device location has changed or can no
-longer be determined.
-
For a summary of the feature highlights in Google Play services 7.0, see the
-announcement
-blog post.
-
-
Places - Using the Google Places API for Android, you can build
- location-aware apps that respond contextually to the local businesses and other places near
- the device. Use the built-in place picker UI widget and API methods to find the device’s
- current place, autocomplete users’ queries, and more.
-
Location settings - While the
-
- {@code FusedLocationProviderApi}
- combines multiple sensors to give you the optimal location, the accuracy of the location your
- app receives still depends greatly on the settings enabled on the device (GPS, wifi, airplane
- mode, and others). Using the new
-
- {@code SettingsApi}
- class, you can bring up a Location Settings dialog which displays a one-touch control for users
- to change their settings without leaving your app.
-
-
Fit - The Google Fit API is now more efficient with modular calls to specific
- functionality within the API. You can now also access distance and granular sleep data.
-
Play Game services - The Nearby Connections API allows users to connect to
- each other and exchange messages over a local network. This API supports local multiplayer
- and second screen gaming.
-
Google API client - This release introduces the
- {@code GoogleApiClient.Builder.requestServerAuthCode()} method. This API makes it significantly easier
- to enable servers to be able to make Google API calls on behalf of users. This method reduces
- the lines of boilerplate code that you previously had to implement.
-
- Drive - This release adds
-
- {@code trash()} and
-
- {@code untrash()} methods to the
-
- {@code DriveResource}
- class. These methods enable you to move user-visible files and folders to the trash or
- restore them from the trash. Trashing a folder recursively trashes its children. The
-
- {@code isExplicitlyTrashed()} method indicates whether a resource was trashed directly,
- or as the result of a trashed parent.
-
SafetyNet API - The API lets you check if your app is running on a device
- that matches a device model that has passed Android compatibility testing. The API evaluates
- both software and hardware characteristics of a device to determine whether it matches a
- known-good configuration that has been previously determined to be compatible. You can use the
- SafetyNet API in conjunction with other tools to determine whether the device appears capable
- of handling specific features in your app.
-
For a summary of the feature highlights in Google Play services 6.5, see the
-announcement
-blog post.
-
-
Maps - The new lite mode lets your app display a
-bitmap image of a map, while still being able to control markers and shapes
-client-side. This is particularly useful when you're showing a number of small
-maps. You can enable or disable a new map toolbar that lets users open
-Google Maps and
-get directions and turn by turn navigation to the selected marker. The
-{@code getMap()} method in
-{@code MapView}
-and
-{@code MapFragment}
-is now deprecated in favor of the new {@code getMapAsync()} method. Similarly,
-the new {@code getStreetViewPanoramaAsync()} method in
-{@code StreetViewPanoramaView} and
-{@code StreetViewPanoramaFragment}
-enables you to get a ready-to-use Street View panorama.
-
Drive - This release introduces support for inserting or
- updating custom properties. You can now create empty files (for example, a user
- preference file that is empty until the user defines some application property).
-
Fit - The Fit API now supports activity segments
- ({@code DataType.TYPE_ACTIVITY_SEGMENT}), which
- enable you to represent pauses within a workout session and to annotate time
- intervals inside a session with different fitness activities.
-
Granular dependency management - If the number of
- references in your app exceeds the
- 65K method reference limit,
- your app may fail to compile. To avoid this problem, you can include just
- the specific Google Play services APIs your app uses, instead of all of them,
- when compiling your app. For more details, see the Android Studio setup
- instructions in
- Setting Up Google Play Services.
-
-
Deprecated clients - The {@code ActivityRecognitionClient},
- {@code LocationClient}, and {@code PlusClient} classes are deprecated. If
- you used those APIs in your app and want to call Google Play services 6.5
- or higher APIs, you must switch to the new programming model that utilizes
- {@code GoogleApiClient}. For more information about using {@code GoogleApiClient}, see Accessing Google APIs.
-
For a summary of the feature highlights in Google Play services 6.1, see the
-announcement
-blog post.
-
-
Drive - This release adds the
-
- CompletionEvent class to notify you when actions are
- committed to the server and respond to conflicts. Recent and starred views
- are now available in the file picker user interface provided by
-
- OpenFileActivityBuilder, and the user interface has been
- updated to use
- material design. A new
-
- DriveResource.setParents() method makes it possible to organize files
- and folders. In addition, the
-
- Contents
- class has been replaced with a
-
- DriveContents class that simplifies working with file
- contents.
-
Fit - The Google Fit developer preview, initially
- announced in August, has been
- refreshed to enable you to test your new fitness apps on any Android device.
-
For a summary of the feature highlights in Google Play services 5.0, see the
-announcement
-blog post.
-
-
Analytics - The Enhanced Ecommerce API allows your app
-to send product related information and actions to Google Analytics. Use this
-API to measure impressions of products seen by users, checkout steps, and
-products purchased. This information can be analyzed for the effectiveness of
-marketing and merchandising efforts, including the impact of internal
-promotions, coupons, and affiliate marketing programs.
-
App Indexing - The App Indexing API provides a way
-for developers to notify Google about deep links in their native apps and
-allows the Google Search App, version 3.6 and above, to drive re-engagement
-through Google Search
-query autocompletions, providing fast and easy access to
-inner pages in apps.
-
Play Games - This release introduces the Quests and
-Saved Games services. The Quests service gives you the ability to issue
-time-bound in-game challenges based on Events data sent from your game, without
-republishing your game (for example: Your game sends an event each time a
-“gem” is found by a player, and you create a quest to “Find 20 gems”). Players
-can complete a quest to earn rewards. Saved Games offers improved functionality
-for saving game state information and visually displaying player game progression.
-
Security - The Security API allows you to easily
-install a dynamic security provider. New versions of Google Play Services will
-keep the security provider up-to-date with the latest security fixes as those
-become available.
-
Wallet - The Save to Google API for Android lets users
-save Wallet Objects to their Google Wallet with the click of a button displayed
-in your Android app.
-
Wearables - The Wearable Data Layer API provides a
- communication channel between your handheld and wearable apps. The API
- consists of a set of data objects that the system can send and synchronize
- and listeners that notify your apps of important events from the other
- device.
-
Mobile Ads - The new in-app purchase APIs allow
- publishers to display in-app purchase ads, which enables users to purchase
- advertised items directly.
-
- The client library contains the interfaces to the individual Google
- services and allows you to obtain authorization from users to gain access
- to these services with their credentials. It also contains APIs that allow
- you to resolve any issues at runtime, such as a missing, disabled, or out-of-date
- Google Play services APK. The client library has a light footprint if you use
- ProGuard as part of your build process, so it won't have
- an adverse impact on your app's file size.
-
-
- If you want to access added features or products, you can upgrade to a new version of the
- client library as they are released. However, upgrading is not
- necessary if you don't care about new features or bug fixes.
- We anticipate more Google services to be continuously added, so be on the lookout for
- these updates.
-
-
-
-
-
-
-
The Google Play services APK
-
- The Google Play services APK contains the individual Google services and runs
- as a background service in the Android OS. You interact with the background service
- through the client library and the service carries out the actions on your behalf.
- An easy-to-use authorization flow is also
- provided to gain access to the each Google service, which provides consistency for both
- you and your users.
-
-
- The Google Play services APK is delivered through the Google Play Store, so
- updates to the services are not dependent on carrier or OEM system image updates. In general, devices
- running Android 2.3 (Gingerbread) or later and have the Google Play Store app installed receive updates within a
- few days. This allows you to use the newest APIs in Google Play services and reach most of the
- devices in the Android ecosystem (devices older than Android 2.3 or devices without the Google
- Play Store app are not supported).
-
-
-
-
-
-
The Google Play services APK on user devices receives regular updates
- for new APIs, features, and bug fixes.
-
-
-
-
The benefits for your app
-
-
Google Play services gives you the freedom to use the newest APIs for popular
-Google services without worrying about device support. Updates to Google Play
-services are distributed automatically by the Google Play Store and new versions
-of the client library are delivered through the Android SDK Manager. This makes it
-easy for you to focus on what's important: your users' experience.
-
-
To get started, set up the SDK and check out
-the various products in the Google Play services platform now!
diff --git a/docs/html/google/play-services/setup.jd b/docs/html/google/play-services/setup.jd
deleted file mode 100644
index 313e59118eab44522f323381b3657876bcb97df1..0000000000000000000000000000000000000000
--- a/docs/html/google/play-services/setup.jd
+++ /dev/null
@@ -1,398 +0,0 @@
-page.title=Setting Up Google Play Services
-@jd:body
-
-
-
-
To develop an app using the Google
-Play services APIs, you need to set up your project with the Google Play services SDK.
-
If you haven't installed the Google Play services SDK yet, go get it now by following the guide
-to Adding SDK Packages.
-
-
To test your app when using the Google Play services SDK, you must use either:
-
-
A compatible Android
- device that runs Android 2.3 or higher and includes Google Play Store.
-
The Android emulator with an AVD
- that runs the Google APIs platform based on Android 4.2.2 or higher.
-
-
-
-
-
Add Google Play Services to Your Project
-
-
-
-
-
-
-
-
To make the Google Play services APIs available to your app:
-
-
Open the build.gradle file inside your application module directory.
-
Note: Android Studio projects contain a top-level
- build.gradle file and a build.gradle file for each module.
- Be sure to edit the file for your application module. See
- Building Your Project with
- Gradle for more information about Gradle.
-
Add a new build rule under dependencies for the latest version of
-play-services. For example:
-
Be sure you update this version number each time Google Play services is updated.
-
Note: If the number of method references in your app exceeds the
-65K limit, your app may fail to compile. You
-may be able to mitigate this problem when compiling your app by specifying only the specific Google
-Play services APIs your app uses, instead of all of them. For information on how to do this,
-see Selectively compiling APIs into your executable.
-
-
-
Save the changes and click Sync Project with Gradle Files
-
-in the toolbar.
-
In versions of Google Play services prior to 6.5, you had to compile the entire package of APIs
-into your app. In some cases, doing so made it more difficult to keep the number of methods
-in your app (including framework APIs, library methods, and your own code) under the 65,536 limit.
-
-
From version 6.5, you can instead selectively compile Google Play service APIs into your app. For
-example, to include only the Google Fit and Android Wear APIs, replace the following line in your
-build.gradle file:
Table 1 shows a list of the separate APIs that you can include when compiling your app, and
-how to describe them in your build.gradle file. Some APIs do not have a separate
-library; include them by including the base library. (This lib is automatically included when
-you include an API that does have a separate library.)
-
-
-Table 1. Individual APIs and corresponding build.gradle descriptions.
Note: ProGuard directives are included in the Play services
-client libraries to preserve the required classes. The
-Android Plugin for Gradle
-automatically appends ProGuard configuration files in an AAR (Android ARchive) package and appends
-that package to your ProGuard configuration. During project creation, Android Studio automatically
-creates the ProGuard configuration files and build.gradle properties for ProGuard use.
-To use ProGuard with Android Studio, you must enable the ProGuard setting in your
-build.gradlebuildTypes. For more information, see the
-ProGuard topic.
-
-
-
-
-
-
-
To make the Google Play services APIs available to your app:
-
-
Copy the library project at
-{@code <android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib/}
- to the location where you maintain your Android app projects.
-
Import the library project into your Eclipse workspace. Click
- File > Import, select Android > Existing Android Code into
-Workspace, and browse to the copy of the library project to import it.
Note: You should be referencing a copy of the
- library that you copied to your development workspace—you should not
- reference the library directly from the Android SDK directory.
-
-
After you've added the Google Play services library as a dependency for your app project,
- open your app's manifest file and add the following tag as a child of the
- {@code <application>}
-element:
-
Once you've set up your project to reference the library project,
-you can begin developing features with the
-Google Play services APIs.
-
-
-
Create a ProGuard Exception
-
-
To prevent ProGuard from stripping away
-required classes, add the following lines in the
-<project_directory>/proguard-project.txt file:
-
--keep class * extends java.util.ListResourceBundle {
- protected Object[][] getContents();
-}
-
--keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
- public static final *** NULL;
-}
-
--keepnames @com.google.android.gms.common.annotation.KeepName class *
--keepclassmembernames class * {
- @com.google.android.gms.common.annotation.KeepName *;
-}
-
--keepnames class * implements android.os.Parcelable {
- public static final ** CREATOR;
-}
-
-
-
-
-
-
-
-
-
To make the Google Play services APIs available to your app:
-
-
Copy the library project at
-{@code <android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib/}
-to the location where you maintain your Android app projects.
Note:
-You should be referencing a copy of the library that you copied to your development
-workspace—you should not reference the library directly from the Android SDK directory.
-
-
After you've added the Google Play services library as a dependency for
- your app project, open your app's manifest file and add the following tag as
- a child of the
- {@code <application>}
- element:
-
Once you've set up your project to reference the library project,
-you can begin developing features with the
-Google Play services APIs.
-
-
-
Create a Proguard Exception
-
-
To prevent ProGuard from stripping away
-required classes, add the following lines in the
-<project_directory>/proguard-project.txt file:
-
--keep class * extends java.util.ListResourceBundle {
- protected Object[][] getContents();
-}
-
--keep public class com.google.android.gms.common.internal.safeparcel.SafeParcelable {
- public static final *** NULL;
-}
-
--keepnames @com.google.android.gms.common.annotation.KeepName class *
--keepclassmembernames class * {
- @com.google.android.gms.common.annotation.KeepName *;
-}
-
--keepnames class * implements android.os.Parcelable {
- public static final ** CREATOR;
-}
-
-
-
-
-
-
-
-
Ensure Devices Have the Google Play services APK
-
-
As described in the Google Play services
-introduction, Google Play delivers service updates for users on
-Android 2.3 and higher through the Google Play Store app. However, updates might not reach
-all users immediately, so your app should verify the version available before attempting to
-perform API transactions.
-
-
-Important:
- Because it is hard to anticipate the state of each device, you must always check for a
- compatible Google Play services APK before you access Google Play services
- features.
-
-
-
Because each app uses Google Play services differently, it's up to you decide the appropriate
-place in your app to verify the Google Play services version. For example, if Google Play
-services is required for your app at all times, you might want to do it when your app first
-launches. On the other hand, if Google Play services is an optional part of your app, you can check
-the version only once the user navigates to that portion of your app.
Another approach is to use the
-{@code isGooglePlayServicesAvailable()} method. You might call this method in the
-{@link android.app.Activity#onResume onResume()} method of the main activity. If the result code is
-{@code SUCCESS},
- then the Google Play services APK is up-to-date and you can continue to make a connection.
-If, however, the result code is
-{@code SERVICE_MISSING},
-{@code SERVICE_VERSION_UPDATE_REQUIRED},
- or
-{@code SERVICE_DISABLED}, then the user needs to install an update. In this case, call the
-
-{@code getErrorDialog()} method and pass it the result error code. The method returns a
-{@link android.app.Dialog} you should show, which provides an appropriate message about the error
-and provides an action that takes the user to Google Play Store to install the update.
-
-
-
To then begin a connection to Google Play services (required by most Google APIs such
-as Google Drive, Google+, and Games), read Accessing Google APIs.
Skeleton for application-specific IntentServices responsible for
- handling communication from Google Cloud Messaging service.
-
- The abstract methods in this class are called from its worker thread, and
- hence should run in a limited amount of time. If they execute long
- operations, they should spawn new threads, otherwise the worker thread will
- be blocked.
-
- Subclasses must provide a public no-arg constructor.
-
- public
- static
- final
- String
-
- ERROR_SERVICE_NOT_AVAILABLE
-
-
-
-
-
-
-
-
-
-
The device can't read the response, or there was a 500/503 from the
- server that can be retried later. The application should use exponential
- back off and retry.
-
- ...where PACKAGE_NAME is the application package.
-
- This method should be used during development time to verify that the
- manifest is properly set up, but it doesn't need to be called once the
- application is deployed to the users' devices.
-
-
Parameters
-
-
-
context
-
application context.
-
-
-
-
-
Throws
-
-
-
IllegalStateException
-
if any of the conditions above is not met.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
-
-
- long
-
- getRegisterOnServerLifespan
- (Context context)
-
HTTP parameter for package name that can be used to restrict message delivery by matching
- against the package name used to generate the registration id.
-
- public
- static
- final
- String
-
- ERROR_INTERNAL_SERVER_ERROR
-
-
-
-
-
-
-
-
-
-
A particular message could not be sent because the GCM servers encountered
- an error. Used only on JSON requests, as in plain text requests internal
- errors are indicated by a 500 response.
-
-
- public
- static
- final
- String
-
- ERROR_NOT_REGISTERED
-
-
-
-
-
-
-
-
-
-
The user has uninstalled the application or turned off notifications.
- Sender should stop sending messages to this device and delete the
- registration_id. The client needs to re-register with the GCM servers to
- receive notifications again.
-
-
-
-
- Constant Value:
-
-
- "NotRegistered"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- ERROR_QUOTA_EXCEEDED
-
-
-
-
-
-
-
-
-
-
Too many messages sent by the sender. Retry after a while.
-
-
-
-
- Constant Value:
-
-
- "QuotaExceeded"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- ERROR_UNAVAILABLE
-
-
-
-
-
-
-
-
-
-
A particular message could not be sent because the GCM servers were not
- available. Used only on JSON requests, as in plain text requests
- unavailability is indicated by a 503 response.
-
-
-
-
- Constant Value:
-
-
- "Unavailable"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- GCM_SEND_ENDPOINT
-
-
- public
- static
- final
- String
-
- JSON_CANONICAL_IDS
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the number of messages with a canonical
- registration id.
-
-
-
-
- Constant Value:
-
-
- "canonical_ids"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_ERROR
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the error field of an individual request.
-
-
-
-
- Constant Value:
-
-
- "error"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_FAILURE
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the number of failed messages.
-
-
-
-
- Constant Value:
-
-
- "failure"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_MESSAGE_ID
-
-
-
-
-
-
-
-
-
-
JSON-only field sent by GCM when a message was successfully sent.
-
-
-
-
- Constant Value:
-
-
- "message_id"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_MULTICAST_ID
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the id of the multicast request.
-
-
-
-
- Constant Value:
-
-
- "multicast_id"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_PAYLOAD
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the payload data.
-
-
-
-
- Constant Value:
-
-
- "data"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_REGISTRATION_IDS
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the registration ids.
-
-
-
-
- Constant Value:
-
-
- "registration_ids"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_RESULTS
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the result of each individual request.
-
-
-
-
- Constant Value:
-
-
- "results"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- JSON_SUCCESS
-
-
-
-
-
-
-
-
-
-
JSON-only field representing the number of successful messages.
-
-
-
-
- Constant Value:
-
-
- "success"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- PARAM_COLLAPSE_KEY
-
-
-
-
-
-
-
-
-
-
HTTP parameter for collapse key.
-
-
-
-
- Constant Value:
-
-
- "collapse_key"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- PARAM_DELAY_WHILE_IDLE
-
-
-
-
-
-
-
-
-
-
HTTP parameter for delaying the message delivery if the device is idle.
-
-
-
-
- Constant Value:
-
-
- "delay_while_idle"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- PARAM_DRY_RUN
-
-
-
-
-
-
-
-
-
-
HTTP parameter for telling gcm to validate the message without actually sending it.
-
-
-
-
- Constant Value:
-
-
- "dry_run"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- PARAM_PAYLOAD_PREFIX
-
-
-
-
-
-
-
-
-
-
Prefix to HTTP parameter used to pass key-values in the message payload.
-
-
-
-
- Constant Value:
-
-
- "data."
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- PARAM_REGISTRATION_ID
-
-
-
-
-
-
-
-
-
-
HTTP parameter for registration id.
-
-
-
-
- Constant Value:
-
-
- "registration_id"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- String
-
- PARAM_RESTRICTED_PACKAGE_NAME
-
-
-
-
-
-
-
-
-
-
HTTP parameter for package name that can be used to restrict message delivery by matching
- against the package name used to generate the registration id.
-
- There are cases when a request is accept and the message successfully
- created, but GCM has a canonical registration id for that device. In this
- case, the server should update the registration id to avoid rejected requests
- in the future.
-
-
- In a nutshell, the workflow to handle a result is:
-
- - Call getMessageId():
- - null means error, call getErrorCodeName()
- - non-null means the message was created:
- - Call getCanonicalRegistrationId()
- - if it returns null, do nothing.
- - otherwise, update the server datastore with the new id.
-
API key obtained through the Google API Console.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Public Methods
-
-
-
-
-
-
-
-
- public
-
-
-
-
- MulticastResult
-
- send
- (Message message, List<String> regIds, int retries)
-
-
-
-
-
-
-
-
-
-
Sends a message to many devices, retrying in case of unavailability.
-
-
- Note: this method uses exponential back-off to retry in
- case of service unavailability and hence could block the calling thread
- for many seconds.
-
-
Parameters
-
-
-
message
-
message to be sent.
-
-
-
regIds
-
registration id of the devices that will receive
- the message.
-
-
-
retries
-
number of retries in case of service unavailability errors.
-
- public
-
-
-
-
- Result
-
- send
- (Message message, String registrationId, int retries)
-
-
-
-
-
-
-
-
-
-
Sends a message to one device, retrying in case of unavailability.
-
-
- Note: this method uses exponential back-off to retry in
- case of service unavailability and hence could block the calling thread
- for many seconds.
-
-
Parameters
-
-
-
message
-
message to be sent, including the device's registration id.
-
-
-
registrationId
-
device where the message will be sent.
-
-
-
retries
-
number of retries in case of service unavailability errors.
-
-
-
-
-
Returns
-
result of the request (see its javadoc for more details).
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- adSizes
-
-
-
-
-
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- adUnitId
-
-
-
-
-
-
-
-
-
-
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- appTheme
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
holo_dark
0
-
holo_light
1
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- buyButtonAppearance
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
classic
1
-
grayscale
2
-
monochrome
3
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- buyButtonHeight
-
-
-
-
-
-
-
-
-
-
-
-
-
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp".
-Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size),
-in (inches), mm (millimeters).
-
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.
-
May be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
match_parent
-1
-
wrap_content
-2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- buyButtonText
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
buy_with_google
1
-
buy_now
2
-
book_now
3
-
donate_with_google
4
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- buyButtonWidth
-
-
-
-
-
-
-
-
-
-
-
-
-
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp".
-Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size),
-in (inches), mm (millimeters).
-
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.
-
May be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
match_parent
-1
-
wrap_content
-2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- cameraBearing
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- cameraTargetLat
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- cameraTargetLng
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- cameraTilt
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- cameraZoom
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- circleCrop
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- environment
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
production
1
-
sandbox
0
-
strict_sandbox
2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- fragmentMode
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
buyButton
1
-
selectionDetails
2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- fragmentStyle
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a reference to another resource, in the form "@[+][package:]type:name"
-or to a theme attribute in the form "?[package:][type:]name".
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- imageAspectRatio
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- imageAspectRatioAdjust
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
none
0
-
adjust_width
1
-
adjust_height
2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- liteMode
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- mapType
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
none
0
-
normal
1
-
satellite
2
-
terrain
3
-
hybrid
4
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsBackground
-
-
-
-
-
-
-
-
-
-
-
-
-
May be a reference to another resource, in the form "@[+][package:]type:name"
-or to a theme attribute in the form "?[package:][type:]name".
-
May be a color value, in the form of "#rgb", "#argb",
-"#rrggbb", or "#aarrggbb".
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsButtonBackground
-
-
-
-
-
-
-
-
-
-
-
-
-
May be a reference to another resource, in the form "@[+][package:]type:name"
-or to a theme attribute in the form "?[package:][type:]name".
-
May be a color value, in the form of "#rgb", "#argb",
-"#rrggbb", or "#aarrggbb".
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsButtonTextAppearance
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a reference to another resource, in the form "@[+][package:]type:name"
-or to a theme attribute in the form "?[package:][type:]name".
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsHeaderTextAppearance
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a reference to another resource, in the form "@[+][package:]type:name"
-or to a theme attribute in the form "?[package:][type:]name".
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsLogoImageType
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
classic
1
-
monochrome
2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsLogoTextColor
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a color value, in the form of "#rgb", "#argb",
-"#rrggbb", or "#aarrggbb".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- maskedWalletDetailsTextAppearance
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a reference to another resource, in the form "@[+][package:]type:name"
-or to a theme attribute in the form "?[package:][type:]name".
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiCompass
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiMapToolbar
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiRotateGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiScrollGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiTiltGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiZoomControls
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- uiZoomGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- useViewLifecycle
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- windowTransitionStyle
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
slide
1
-
none
2
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- zOrderOnTop
-
-
-
-
-
-
-
-
-
-
-
-
-
Must be a boolean value, either "true" or "false".
-
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 symbol is the offset where the adSize
- attribute's value can be found in the AdsAttrs array.
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- AdsAttrs_adSizes
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the adSizes
- attribute's value can be found in the AdsAttrs array.
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- AdsAttrs_adUnitId
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the adUnitId
- attribute's value can be found in the AdsAttrs array.
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- int[]
-
- CustomWalletTheme
-
-
-
-
-
-
-
-
-
-
-
-
-
Attributes that can be used with a CustomWalletTheme.
-
-
- public
- static
-
- int
-
- LoadingImageView_circleCrop
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the circleCrop
- attribute's value can be found in the LoadingImageView array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- LoadingImageView_imageAspectRatio
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- LoadingImageView_imageAspectRatioAdjust
-
-
- public
- static
-
- int
-
- MapAttrs_cameraBearing
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the cameraBearing
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_cameraTargetLat
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the cameraTargetLat
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_cameraTargetLng
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the cameraTargetLng
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_cameraTilt
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the cameraTilt
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_cameraZoom
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the cameraZoom
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a floating point value, such as "1.2".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_liteMode
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the liteMode
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_mapType
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the mapType
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
none
0
-
normal
1
-
satellite
2
-
terrain
3
-
hybrid
4
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiCompass
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiCompass
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiMapToolbar
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiMapToolbar
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiRotateGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiRotateGestures
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiScrollGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiScrollGestures
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiTiltGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiTiltGestures
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiZoomControls
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiZoomControls
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_uiZoomGestures
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the uiZoomGestures
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_useViewLifecycle
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the useViewLifecycle
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- MapAttrs_zOrderOnTop
-
-
-
-
-
-
-
-
-
-
-
-
-
This symbol is the offset where the zOrderOnTop
- attribute's value can be found in the MapAttrs array.
-
-
-
Must be a boolean value, either "true" or "false".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- int[]
-
- WalletFragmentOptions
-
-
-
-
-
-
-
-
-
-
-
-
-
Attributes that can be used with a WalletFragmentOptions.
-
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp".
-Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size),
-in (inches), mm (millimeters).
-
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.
-
May be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
match_parent
-1
-
wrap_content
-2
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- WalletFragmentStyle_buyButtonText
-
May be a dimension value, which is a floating point number appended with a unit such as "14.5sp".
-Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size),
-in (inches), mm (millimeters).
-
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.
-
May be one of the following constant values.
-
-
-
-
-
Constant
Value
Description
-
match_parent
-1
-
wrap_content
-2
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- WalletFragmentStyle_maskedWalletDetailsBackground
-
Must be a color value, in the form of "#rgb", "#argb",
-"#rrggbb", or "#aarrggbb".
-
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.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
-
- int
-
- WalletFragmentStyle_maskedWalletDetailsTextAppearance
-
-
- public
- static
- final
- String
-
- ACTION_ACCEPT_ITEM
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for marking an existing list item complete. The intent can use extras to
- specify the item EXTRA_ITEM_QUERY (e.g. "buy eggs") and the list with
- EXTRA_LIST_QUERY (e.g. "todo"). Alternatively the item can be specified using
- setData(Uri) - the intent data will always be preferred over
- using EXTRA_ITEM_QUERY. If the item is ambiguous, the activity
- MUST ask the user to disambiguate.
-
- The activity MUST verify the operation with the user before committing the change.
-
-
- public
- static
- final
- String
-
- ACTION_APPEND_ITEM_LIST
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for appending to an existing item list. The intent should include an extra to
- specify the list to append with EXTRA_LIST_QUERY or specify the list
- with setData(Uri). If both are specified, the intent data will
- be preferred. If the name is ambiguous, the activity MUST ask the user to disambiguate.
-
- The intent can optionally include an extra specifying the item EXTRA_ITEM_NAME to
- add to the list. If the item is not specified, the activity should present a UI for the item
- to add.
-
- The activity MUST verify the operation with the user before committing the change.
-
-
- public
- static
- final
- String
-
- ACTION_CREATE_ITEM_LIST
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for creating an item list. The intent can include optional extras to
- specify the list name EXTRA_LIST_NAME and the initial list of items
- EXTRA_ITEM_NAMES. For example, a shopping list might have a list name of "shopping
- list" and item names of "ham" and "eggs".
-
- The activity MUST verify the operation with the user before committing the change.
-
-
- public
- static
- final
- String
-
- ACTION_DELETE_ITEM
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for deleting an existing list item. The intent can use extras to
- specify the item EXTRA_ITEM_QUERY (e.g. "buy eggs") and the list with
- EXTRA_LIST_QUERY (e.g. "todo"). Alternatively the item can be specified using
- setData(Uri) - the intent data will always be preferred over
- using EXTRA_ITEM_QUERY. If the item is ambiguous, the activity
- MUST ask the user to disambiguate.
-
- The activity MUST verify the operation with the user before committing the change.
-
-
- public
- static
- final
- String
-
- ACTION_DELETE_ITEM_LIST
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for removing an item list. The intent can include an optional extra to
- specify a list query EXTRA_LIST_QUERY that is used to identify the note to be
- removed. For example if the query is "shopping list" and there are two potentially matching
- lists "food shopping list" and "clothes shopping list" then both should be presented.
-
- The list to be deleted can also be specified with setData(Uri)
- - the intent data will be preferred if EXTRA_LIST_QUERY is also specified.
-
- The activity MUST verify the operation with the user before committing the change.
-
-
- public
- static
- final
- String
-
- ACTION_REJECT_ITEM
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for marking an existing list item incomplete. The intent can use extras to
- specify the item EXTRA_ITEM_QUERY (e.g. "buy eggs") and the list with
- EXTRA_LIST_QUERY (e.g. "todo"). Alternatively the item can be specified using
- setData(Uri) - the intent data will always be preferred over
- using EXTRA_ITEM_QUERY. If the item is ambiguous, the activity
- MUST ask the user to disambiguate.
-
- The activity MUST verify the operation with the user before committing the change.
-
-
- public
- static
- final
- String
-
- EXTRA_ITEM_NAMES
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent extra for specifying multiple items when creating a list with ACTION_CREATE_ITEM_LIST as a string array. The individual values should
- be specied according to EXTRA_ITEM_NAME.
-
-
- public
- static
- final
- String
-
- EXTRA_ITEM_QUERY
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent extra specifying an unstructured query to identify a specific item as a string. The
- query should be matched against the name provided in EXTRA_ITEM_NAME.
-
-
- public
- static
- final
- String
-
- EXTRA_LIST_QUERY
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent extra specifying an unstructured query for an item list as a string. This could
- search the list title or the items in the list to find a match, although matching the title
- should be preferred.
-
-
- public
- static
- final
- String
-
- ACTION_APPEND_NOTE
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for appending to an existing note. The intent should include an extra to
- specify the text EXTRA_TEXT to append.
-
- The intent should specify the note to append to with the EXTRA_NOTE_QUERY extra.
- Alternatively the note can be specified using setData(Uri) -
- the intent data URI will always be preferred over EXTRA_NOTE_QUERY. If the note
- is ambiguous, the activity MUST ask the user to disambiguate.
-
- The activity MUST verify the result with the user before committing the change.
-
-
- public
- static
- final
- String
-
- ACTION_DELETE_NOTE
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for removing an existing note.
-
- The intent should specify the note to append to with the EXTRA_NOTE_QUERY extra.
- Alternatively the note can be specified using setData(Uri) -
- the intent data URI will always be preferred over EXTRA_NOTE_QUERY. If the note
- is ambiguous, the activity MUST ask the user to disambiguate.
-
- The activity MUST verify the result with the user before committing the change.
-
-
- public
- static
- final
- String
-
- EXTRA_NAME
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent extra specifying an optional title or subject for the note as a string. The name
- can be used to locate the note later with EXTRA_NOTE_QUERY.
-
-
- public
- static
- final
- String
-
- ACTION_RESERVE_TAXI_RESERVATION
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for reserving a taxi. The application MUST confirm whatever action
- will be taken with the user before completing the action (e.g. confirmation dialog).
-
-
- public
- static
- final
- String
-
- ACTION_SEARCH
-
-
-
-
-
-
-
-
-
-
-
-
-
Intent action for performing an in-app search. The intent should include an optional
- extra to specify the text to search for EXTRA_QUERY. If no extras are
- provided, the application should just show an Activity with the search UI activated.
-
Add extra parameters to pass to a specific ad network adapter. networkExtras
- should be an instance of com.google.ads.mediation.NetworkExtras, which is
- provided by ad network adapters.
-
Sets the request agent string to identify the ad request's origin. Third party libraries
- that reference the Mobile Ads SDK should call this method to denote the platform from
- which the ad request originated. For example, if a third party ad network called
- "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this method
- with "CoolAds".
-
- If you set this method to true, you will indicate that your app should be treated
- as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).
-
- If you set this method to false, you will indicate that your app should not be
- treated as child-directed for purposes of the Children’s Online Privacy Protection Act
- (COPPA).
-
- If you do not set this method, ad requests will include no indication of how you would
- like your app treated with respect to COPPA.
-
- By setting this method, you certify that this notification is accurate and you are
- authorized to act on behalf of the owner of the app. You understand that abuse of this
- setting may result in termination of your Google account.
-
- Note: it may take some time for this designation to be fully implemented in applicable
- Google services.
-
- This designation will only apply to ad requests for which you have set this method.
-
-
Parameters
-
-
-
tagForChildDirectedTreatment
-
Set to true to indicate that your app should
- be treated as child-directed. Set to false to indicate that your app
- should not be treated as child-directed.
-
Returns the user's location targeting information. Returns null if the location was
- not set.
-
-
-
-
-
-
-
-
-
-
-
- public
-
-
-
-
- T
-
- getNetworkExtras
- (Class<T> networkExtrasClass)
-
-
-
-
-
-
-
-
-
-
-
-
-
Returns extra parameters to pass to a specific ad network adapter. Ad network adapters
- provide a NetworkExtras class. Returns null if no network extras of the
- provided type were set.
-
-
- public
- static
- final
- int
-
- AUTO_HEIGHT
-
-
-
-
-
-
-
-
-
-
-
-
-
Constant that will cause the height of the ad to scale based on the height of the device in
- the current orientation. An AUTO_HEIGHT ad determines its height during
- initialization of the AdView and never changes after that.
-
-
-
-
- Constant Value:
-
-
- -2
- (0xfffffffe)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- int
-
- FULL_WIDTH
-
-
-
-
-
-
-
-
-
-
-
-
-
Constant that will cause the width of the ad to match the width of the device in the current
- orientation. A FULL_WIDTH ad determines its width during initialization of the
- AdView and never changes after that.
-
Mobile Marketing Association (MMA) banner ad size (320x50 density-independent pixels).
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- AdSize
-
- FULL_BANNER
-
-
-
-
-
-
-
-
-
-
-
-
-
Interactive Advertising Bureau (IAB) full banner ad size (468x60 density-independent pixels).
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- AdSize
-
- LARGE_BANNER
-
-
-
-
-
-
-
-
-
-
-
-
-
Large banner ad size (320x100 density-independent pixels).
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- AdSize
-
- LEADERBOARD
-
-
-
-
-
-
-
-
-
-
-
-
-
Interactive Advertising Bureau (IAB) leaderboard ad size (728x90 density-independent pixels).
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- AdSize
-
- MEDIUM_RECTANGLE
-
-
-
-
-
-
-
-
-
-
-
-
-
Interactive Advertising Bureau (IAB) medium rectangle ad size (300x250 density-independent
- pixels).
-
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- AdSize
-
- SMART_BANNER
-
-
-
-
-
-
-
-
-
-
-
-
-
A dynamically sized banner that is full-width and auto-height.
-
-
-
-
-
-
-
-
-
-
-
-
- public
- static
- final
- AdSize
-
- WIDE_SKYSCRAPER
-
-
-
-
-
-
-
-
-
-
-
-
-
IAB wide skyscraper ad size (160x600 density-independent pixels). This size is currently not
- supported by the Google Mobile Ads network; this is intended for mediation ad networks only.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Public Constructors
-
-
-
-
-
-
-
-
- public
-
-
-
-
-
-
- AdSize
- (int width, int height)
-
Destroy the AdView. This method should be called in the parent Activity's
- onDestroy() method. No other methods should be called on the
- AdView after destroy() is called.
-
Returns the mediation adapter class name. In the case of a mediated ad response, this is the
- name of the class that was responsible for performing the ad request and rendering the ad.
- For non-mediated responses, this value will be null.
-
Set a PlayStorePurchaseListener and app's public key for this AdView.
- null for parameter palyStorePurchaseListener is acceptable but
- PlayStorePurchaseListener is not set in this case.
- null for parameter publicKey is acceptable but SDK will work in developer mode and
- skip verifying purchase data signature with public key.
- public class MyActivity extends Activity {
- private InterstitialAd mInterstitialAd;
- private Button mNextLevelButton;
- private TextView mTextView;
-
- @Override
- public void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
-
- // Create an interstitial ad. When a natural transition in the app occurs (such as a
- // level ending in a game), show the interstitial. In this simple example, the press of a
- // button is used instead.
- //
- // If the button is clicked before the interstitial is loaded, the user should proceed to
- // the next part of the app (in this case, the next level).
- //
- // If the interstitial is finished loading, the user will view the interstitial before
- // proceeding.
- mInterstitialAd = new InterstitialAd(this);
- mInterstitialAd.setAdUnitId("myAdUnitId");
-
- // Create an ad request.
- AdRequest.Builder adRequestBuilder = new AdRequest.Builder();
-
- // Optionally populate the ad request builder.
- adRequestBuilder.addTestDevice(AdRequest.DEVICE_ID_EMULATOR);
-
- // Set an AdListener.
- mInterstitialAd.setAdListener(new AdListener() {
- @Override
- public void onAdLoaded() {
- Toast.makeText(MyActivity.this,
- "The interstitial is loaded", Toast.LENGTH_SHORT).show();
- }
-
- @Override
- public void onAdClosed() {
- // Proceed to the next level.
- goToNextLevel();
- }
- });
-
- // Start loading the ad now so that it is ready by the time the user is ready to go to
- // the next level.
- mInterstitialAd.loadAd(adRequestBuilder.build());
-
- // Create the button to go to the next level.
- mNextLevelButton = new Button(this);
- mNextLevelButton.setText("Next Level");
- mNextLevelButton.setOnClickListener(new View.OnClickListener() {
- @Override
- public void onClick(View view) {
- // Show the interstitial if it is ready. Otherwise, proceed to the next level
- // without ever showing it.
- if (mInterstitialAd.isLoaded()) {
- mInterstitialAd.show();
- } else {
- // Proceed to the next level.
- goToNextLevel();
- }
- }
- });
-
- // Add the next level button to the layout.
- LinearLayout layout = new LinearLayout(this);
- layout.setOrientation(LinearLayout.VERTICAL);
- layout.addView(mNextLevelButton);
-
- // Create a TextView to display the current level.
- mTextView = new TextView(this);
- mTextView.setText("Level 1");
- layout.addView(mTextView);
-
- setContentView(layout);
- }
-
- public void goToNextLevel() {
- // Show the next level (and disable the next level button since there are no more levels.
- mNextLevelButton.setEnabled(false);
- mTextView.setText("Level 2");
- }
- }
Returns the mediation adapter class name. In the case of a mediated ad response, this is the
- name of the class that was responsible for performing the ad request and rendering the ad.
- For non-mediated responses, this value will be null.
-
-
-
-
-
-
-
-
-
-
-
- public
-
-
-
-
- boolean
-
- isLoaded
- ()
-
-
-
-
-
-
-
-
-
-
-
-
-
Returns true if the ad was successfully loaded and is ready to be shown.
-
Set an PlayStorePurchaseListener and app's public key for this
- InterstitialAd. null for parameter palyStorePurchaseListener is acceptable
- but PlayStorePurchaseListener is not set in this case.
- null for parameter publicKey is acceptable but SDK will work in developer mode and
- skip verifying purchase data signature with public key.
A listener interface for app events triggered by ads. App events allow JavaScript within an ad to
- trigger events in the application. The ad can trigger the app event with a name and optional
- data. It is then up to the application to decide how to handle the event.
-
- Sets an identifier for use in frequency capping, audience segmentation and targeting,
- sequential ad rotation, and other audience-based ad delivery controls across devices.
-
-
-
-
Add extra parameters to pass to a specific ad network adapter. networkExtras
- should be an instance of com.google.ads.mediation.NetworkExtras, which is
- provided by ad network adapters.
-
Causes a device to receive test ads. The deviceId can be obtained by viewing the
- logcat output after creating a new ad. For emulators, use
- DEVICE_ID_EMULATOR.
-
Sets an identifier for use in frequency capping, audience segmentation and targeting,
- sequential ad rotation, and other audience-based ad delivery controls across devices.
-
Sets the request agent string to identify the ad request's origin. Third party libraries
- that reference the Mobile Ads SDK should call this method to denote the platform from
- which the ad request originated. For example, if a third party ad network called
- "CoolAds network" mediates requests to the Mobile Ads SDK, it should call this method
- with "CoolAds".
-
- If you set this method to true, you will indicate that your app should be treated
- as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).
-
- If you set this method to false, you will indicate that your app should not be
- treated as child-directed for purposes of the Children’s Online Privacy Protection Act
- (COPPA).
-
- If you do not set this method, ad requests will include no indication of how you would
- like your app treated with respect to COPPA.
-
- By setting this method, you certify that this notification is accurate and you are
- authorized to act on behalf of the owner of the app. You understand that abuse of this
- setting may result in termination of your Google account.
-
- Note: it may take some time for this designation to be fully implemented in applicable
- Google services.
-
- This designation will only apply to ad requests for which you have set this method.
-
-
Parameters
-
-
-
tagForChildDirectedTreatment
-
Set to true to indicate that your app should
- be treated as child-directed. Set to false to indicate that your app
- should not be treated as child-directed.
-
- Returns the identifier used for frequency capping, audience segmentation and targeting,
- sequential ad rotation, and other audience-based ad delivery controls across devices.
-
-
-
-
Returns true if manual impression reporting is enabled.
-
-
-
-
-
-
-
-
-
-
-
- public
-
-
-
-
- T
-
- getNetworkExtras
- (Class<T> networkExtrasClass)
-
-
-
-
-
-
-
-
-
-
-
-
-
Returns extra parameters to pass to a specific ad network adapter. Ad network adapters
- provide a NetworkExtras class. Returns null if no network extras of the
- provided type were set.
-
Returns the identifier used for frequency capping, audience segmentation and targeting,
- sequential ad rotation, and other audience-based ad delivery controls across devices.
-
Changes the correlator that is sent with ad requests, effectively starting a new page view.
- The correlator is the same for all the ad requests coming from one page view, and unique
- across page views. After updating the correlator, ads must be refreshed for the new
- correlator to take effect.
-
The View to display banner ads for use with DoubleClick for Publishers. The
- ad size and ad unit ID must be set prior to calling loadAd(PublisherAdRequest).
-
- Sample code:
-
- public class MyActivity extends Activity {
- private PublisherAdView mPublisherAdView;
-
- @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.
- mPublisherAdView = new PublisherAdView(this);
- mPublisherAdView.setAdSize(AdSize.SMART_BANNER);
- mPublisherAdView.setAdUnitId("myAdUnitId");
-
- // Create an ad request.
- PublisherAdRequest.Builder publisherAdRequestBuilder = new PublisherAdRequest.Builder();
-
- // Optionally populate the ad request builder.
- publisherAdRequestBuilder.addTestDevice(PublisherAdRequest.DEVICE_ID_EMULATOR);
-
- // Add the PublisherAdView to the view hierarchy.
- layout.addView(mPublisherAdView);
-
- // Start loading the ad.
- mPublisherAdView.loadAd(PublisherAdRequestBuilder.build());
-
- setContentView(layout);
- }
-
- @Override
- public void onResume() {
- super.onResume();
-
- // Resume the PublisherAdView.
- mPublisherAdView.resume();
- }
-
- @Override
- public void onPause() {
- // Pause the PublisherAdView.
- mPublisherAdView.pause();
-
- super.onPause();
- }
-
- @Override
- public void onDestroy() {
- // Destroy the PublisherAdView.
- mPublisherAdView.destroy();
-
- super.onDestroy();
- }
- }
Returns the mediation adapter class name. In the case of a mediated ad response, this is the
- name of the class that was responsible for performing the ad request and rendering the ad.
- For non-mediated responses, this value will be null.
-
Sets the supported sizes of the banner ad. In most cases, only one ad size will be specified.
-
- Multiple ad sizes can be specified if your application can appropriately handle multiple
- ad sizes. For example, your application might call getAdSize() during the
- onAdLoaded() callback and change the layout according to the size of the ad
- that was loaded. If multiple ad sizes are specified, the PublisherAdView will
- assume the size of the first ad size until an ad is loaded.
-
- This method also immediately resizes the currently displayed ad, so calling this method after an
- ad has been loaded is not recommended unless you know for certain that the content of the
- ad will render correctly in the new ad size. This can be used if an ad needs to be resized
- after it has been loaded. If more than one ad size is specified, the currently displayed ad
- will be resized to the first ad size.
-
-
Google Play services, Version 7.3
Google Play services, Version 7.0
- 
-in the toolbar.
- 
- 