API Example ID
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A API Instance ID permite integrar o Instance ID ao seu app Android
ou iOS. O Instance ID fornece um identificador exclusivo para cada instância do
app e um mecanismo para autenticar e autorizar ações. O InstanceID
tem vida
longa, mas pode expirar pelos seguintes motivos:
- Redefinir o dispositivo para a configuração original.
- O usuário desinstala o app.
- O usuário executa a opção "Limpar dados" no app.
- Dispositivo não usado por um período prolongado (o dispositivo e a região determinam o
período).
- O serviço de ID de instância detecta abusos ou erros e redefine o
InstanceID
.
- Código do lado do servidor, se o app cliente exigir essa funcionalidade.
O serviço de ID de instância notifica seu app sobre uma redefinição de InstanceID
por meio de
callback para um InstanceIDListenerService
. Se o app receber essa
notificação, ele precisará chamar getToken()
e recuperar o novo InstanceID
e atualizar os servidores.
Use o método getToken
para provar a propriedade do InstanceID
e permitir que
os servidores acessem dados ou serviços associados ao app. O método segue
os padrões do OAuth2 e exige um authorizedEntity
e um scope
. O
authorizedEntity
pode ser um ID de projeto ou outro InstanceID
e determina
os serviços autorizados a usar o token gerado. O scope
determina o serviço ou dados específicos a que o token permite acesso.
Saiba mais sobre a API Instance ID para:
Android
iOS
Servidor
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-31 UTC.
[null,null,["Última atualização 2025-08-31 UTC."],[[["\u003cp\u003eThe Instance ID API provides a unique identifier for each app instance and enables authentication and authorization.\u003c/p\u003e\n"],["\u003cp\u003eInstance IDs are long-lived but can expire due to various factors like device reset, uninstallation, data clearing, extended inactivity, or service-detected issues.\u003c/p\u003e\n"],["\u003cp\u003eUpon Instance ID reset, apps are notified and must retrieve a new ID using \u003ccode\u003egetToken()\u003c/code\u003e and update their servers.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetToken()\u003c/code\u003e method, using OAuth2 patterns, verifies Instance ID ownership and grants server access to associated data or services based on authorized entity and scope.\u003c/p\u003e\n"]]],[],null,["# Instance ID API\n\nThe Instance ID API lets you integrate Instance ID with your Android\nor iOS app. Instance ID provides a unique identifier for each instance of\nyour app and a mechanism to authenticate and authorize actions. The `InstanceID` is long\nlived, but may expire for the following reasons:\n\n- Device factory reset.\n- User uninstalls the app.\n- User performs \"Clear Data\" in the app.\n- Device unused for an extended period (device and region determines the timespan).\n- Instance ID service detects abuse or errors and resets the `InstanceID`.\n- Server-side code if your client app requires that functionality.\n\nThe Instance ID service notifies your app of an `InstanceID` reset via\ncallback to a `InstanceIDListenerService`. If your app receives this\nnotification, it must call `getToken()` and retrieve the new `InstanceID`,\nand update its servers.\n\nUse the `getToken` method to prove the ownership of the `InstanceID` and to allow\nservers to access data or services associated with the app. The method follows\nthe patterns of OAuth2, and requires an `authorizedEntity` and `scope`. The\n`authorizedEntity` can be a project ID or another `InstanceID`, and it determines\nthe services that are authorized to use the generated token. The `scope`\ndetermines the specific service or data to which the token allows access.\n\nLearn more about the Instance ID API for:\n\n[Android](/instance-id/reference/android/api)\n[iOS](/instance-id/reference/ios/api)\n[Server](/instance-id/reference/server)"]]