Stay organized with collections
Save and categorize content based on your preferences.
public interface Api.ApiOptions
Known indirect subclasses
Base interface for API options. These are used to configure specific parameters for individual API surfaces. The default implementation has no parameters.
Summary
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-17 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-17 UTC."],[[["\u003cp\u003e\u003ccode\u003eApi.ApiOptions\u003c/code\u003e is a base interface used to configure parameters for individual API surfaces within the Google Android API.\u003c/p\u003e\n"],["\u003cp\u003eIt has various sub-interfaces like \u003ccode\u003eHasOptions\u003c/code\u003e, \u003ccode\u003eNotRequiredOptions\u003c/code\u003e, \u003ccode\u003eHasAccountOptions\u003c/code\u003e, \u003ccode\u003eHasGoogleSignInAccountOptions\u003c/code\u003e, and \u003ccode\u003eOptional\u003c/code\u003e for different API configuration needs.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApi.ApiOptions.NoOptions\u003c/code\u003e is an implementation for APIs that don't require any specific options.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use \u003ccode\u003eApi.ApiOptions\u003c/code\u003e and its subtypes to customize the behavior of Google APIs within their Android applications.\u003c/p\u003e\n"],["\u003cp\u003eThe default implementation of \u003ccode\u003eApi.ApiOptions\u003c/code\u003e has no parameters, offering a basic configuration for APIs.\u003c/p\u003e\n"]]],[],null,["# Api.ApiOptions\n==============\n\n[Kotlin](/android/reference/kotlin/com/google/android/gms/common/api/Api.ApiOptions \"View this page in Kotlin\") \\|Java \n\n\n```\npublic interface Api.ApiOptions\n```\n\n\u003cbr /\u003e\n\nKnown direct subclasses \n[Api.ApiOptions.HasOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions), [Api.ApiOptions.NotRequiredOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions) \n\n|-----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Api.ApiOptions.HasOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions) | Base interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) in [Api](/android/reference/com/google/android/gms/common/api/Api)s that have options. |\n| [Api.ApiOptions.NotRequiredOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions) | Base interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that are not required, don't exist. |\n\nKnown indirect subclasses \n[Api.ApiOptions.HasAccountOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasAccountOptions), [Api.ApiOptions.HasGoogleSignInAccountOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasGoogleSignInAccountOptions), [Api.ApiOptions.NoOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions), [Api.ApiOptions.Optional](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional), [GoogleSignInOptions](/android/reference/com/google/android/gms/auth/api/signin/GoogleSignInOptions) \n\n|---------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Api.ApiOptions.HasAccountOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasAccountOptions) | An interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that include an account. |\n| [Api.ApiOptions.HasGoogleSignInAccountOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasGoogleSignInAccountOptions) | An interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that includes a [GoogleSignInAccount](/android/reference/com/google/android/gms/auth/api/signin/GoogleSignInAccount) |\n| [Api.ApiOptions.NoOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions) | [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) implementation for [Api](/android/reference/com/google/android/gms/common/api/Api)s that do not take any options. |\n| [Api.ApiOptions.Optional](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional) | Base interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that are optional. |\n| [GoogleSignInOptions](/android/reference/com/google/android/gms/auth/api/signin/GoogleSignInOptions) | **This class is deprecated.** Use [Credential Manager](https://developer.android.com/training/sign-in/credential-manager) for authentication or [Google Identity Services](https://developers.google.com/identity/sign-in/android/authorize-access) for authorization. \u003cbr /\u003e |\n\n*** ** * ** ***\n\nBase interface for API options. These are used to configure specific parameters for individual API surfaces. The default implementation has no parameters.\n\nSummary\n-------\n\n| ### Nested types |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `public interface `[Api.ApiOptions.HasAccountOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasAccountOptions)` extends `[Api.ApiOptions.HasOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions)`, `[Api.ApiOptions.NotRequiredOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions) An interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that include an account. |\n| `public interface `[Api.ApiOptions.HasGoogleSignInAccountOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasGoogleSignInAccountOptions)` extends `[Api.ApiOptions.HasOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions) An interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that includes a [GoogleSignInAccount](/android/reference/com/google/android/gms/auth/api/signin/GoogleSignInAccount) |\n| `public interface `[Api.ApiOptions.HasOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions)` extends `[Api.ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) Base interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) in [Api](/android/reference/com/google/android/gms/common/api/Api)s that have options. |\n| `public final class `[Api.ApiOptions.NoOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions)` implements `[Api.ApiOptions.NotRequiredOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions) [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) implementation for [Api](/android/reference/com/google/android/gms/common/api/Api)s that do not take any options. |\n| `public interface `[Api.ApiOptions.NotRequiredOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions)` extends `[Api.ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) Base interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that are not required, don't exist. |\n| `public interface `[Api.ApiOptions.Optional](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.Optional)` extends `[Api.ApiOptions.HasOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.HasOptions)`, `[Api.ApiOptions.NotRequiredOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NotRequiredOptions) Base interface for [ApiOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions) that are optional. |\n\n| ### Constants |\n|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `default static final `[Api.ApiOptions.NoOptions](/android/reference/com/google/android/gms/common/api/Api.ApiOptions.NoOptions) | [NO_OPTIONS](/android/reference/com/google/android/gms/common/api/Api.ApiOptions#NO_OPTIONS()) Static instance of `NoOptions`. |\n\nConstants\n---------\n\n### NO_OPTIONS\n\n```\ndefault static final Api.ApiOptions.NoOptions NO_OPTIONS\n```\n\nStatic instance of `NoOptions`."]]
