Testar com diferentes tipos de credenciais e escopos
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A seção de credenciais do APIs Explorer permite testar com diferentes
credenciais e escopos. Esse recurso é útil para garantir que você está usando as
credenciais e o escopo mínimos necessários para invocar um endpoint de API.
Testar com credenciais diferentes
Por padrão, os tipos de credenciais OAuth 2 e chave de API são marcados.
Se você quiser testar com apenas uma credencial, marque o tipo de credencial a ser usado e desmarque o outro. Confira as regras gerais para
escolher uma credencial para testar:
Se você estiver usando um método para acessar dados públicos, como os do Google Maps, use uma chave de API como sua credencial. Marque Chave de API e desmarque Google OAuth 2.0.
Se você estiver usando um método para acessar dados particulares, como os dados do Google Drive do usuário, use uma credencial do OAuth 2. Desmarque Chave de API e marque Google OAuth 2.0.
Se você receber um resultado 200, a credencial será suficiente
para acessar os dados. Se você receber um resultado 401, use uma credencial OAuth 2 para acessar os dados.
Testar com diferentes escopos
Um escopo é uma string, como
https://www.googleapis.com/auth/drive.metadata.readonly, que define um nível de
acesso aos recursos necessários para seu app, como o nível de acesso aos dados
dos usuários. O ideal é que o app use escopos com o nível mais restrito de acesso aos dados do usuário. Métodos diferentes podem exigir escopos diferentes. Por exemplo, um método em uma API pode exigir
pelo menos um escopo somente leitura, enquanto outros métodos podem exigir um escopo
de leitura e gravação.
Por padrão, todos os escopos do OAuth 2.0 do Google para uma API são ativados no APIs Explorer. Para testar com um escopo específico:
Na seção "Credenciais Google OAuth 2.0", clique em mostrar escopos.
Verifique o escopo a ser usado ao invocar o método.
Clique em Executar para executar a API usando apenas o escopo selecionado. O APIs Explorer mostra uma tela de autorização pedindo que você conceda acesso para usar o escopo.
Clique em Permitir. Os resultados aparecem abaixo do botão "Executar".
Se o APIs Explorer mostrar um resultado de 200 em um "application/json", o escopo será suficiente para invocar o método. Se o APIs Explorer mostrar um resultado 403, você escolheu um escopo insuficiente para invocar o método. Tente um escopo mais amplo.
Para mais informações sobre a seleção de escopo, consulte a seção de autenticação e autorização da documentação da sua API do Google específica.
Revogar o acesso autorizado para testar com novos escopos
Depois de usar a tela de autorização do Google para aprovar a autorização,
a API Explorer permanece autorizada a fazer solicitações autenticadas enquanto
as credenciais não expiram. Desmarcar escopos não redefine as
credenciais e os escopos aprovados anteriormente. Se você quiser testar com uma nova configuração de escopo, revogue as credenciais aprovadas anteriormente.
Para revogar as credenciais usadas pelo APIs Explorer:
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eThe API Explorer's credentials section allows testing with different credentials (API key or Google OAuth 2.0) and scopes to ensure minimal access requirements.\u003c/p\u003e\n"],["\u003cp\u003eAPI keys are suitable for accessing public data, while OAuth 2.0 credentials are necessary for private data access.\u003c/p\u003e\n"],["\u003cp\u003eUsing the scopes feature, you can select specific access levels (read-only, read-write, etc.) and verify their sufficiency for invoking API methods.\u003c/p\u003e\n"],["\u003cp\u003eTo test with new scopes, you may need to revoke previously approved credentials through your Google account settings.\u003c/p\u003e\n"]]],[],null,["# Test with different credential types and scopes\n\nThe APIs Explorer's credentials section lets you test with different\ncredentials and scopes. This feature is useful in ensuring you're using the\nminimal required credentials and scope to invoke an API endpoint.\n\nTest with different credentials\n-------------------------------\n\nBy default, both the OAuth 2 and API Key credential types are checked.\nIf you want to test with only one credential, check on the credential type to\nuse (and uncheck the other credential type). Following are the general rules for\npicking a credential to test with:\n\n- If you're using a method to access public data, such as Google Maps data, you\n can use an API key as your credential. Check **API key** and uncheck\n **Google OAuth 2.0**.\n\n- If you're using a method to access private data, such as the user's Google\n Drive data, you must use an OAuth 2 credential. Uncheck **API key** and check\n **Google OAuth 2.0**.\n\nIf you receive a result of 200, the credential is sufficient\nfor accessing the data. If you receive a result of 401, you need\nto use OAuth 2 credential to access the data.\n\nTest with different scopes\n--------------------------\n\nA scope is a string, such as\n`https://www.googleapis.com/auth/drive.metadata.readonly`, defining a level of\naccess to resources required by your app, such as the level of access to data\nowned by the users. Ideally, you want your app to use scopes with\nthe narrowest level of access to the user's data. Different methods might\nrequire different scopes. For example, a method in an API might require\nat least a read-only scope, while other methods might require a read-write\nscope.\n| **Note:** Scopes are only applicable to Google OAuth 2.0. If you're testing with an API key, you won't test with different scopes.\n\nBy default, all Google OAuth 2.0 scopes for an API are enabled in the APIs\nExplorer. To test with a specific scope:\n\n1. In the Credentials Google OAuth 2.0 section, click **show scopes**.\n2. Check the scope to use when invoking the method.\n3. Click **Execute** to execute the API using only the selected scope. The APIs Explorer shows an authorization screen asking you to grant access to use the scope.\n4. Click **Allow**. The results appear below the Execute button.\n\nIf the APIs Explorer shows a result of 200 under an \"application/json\", then the\nscope is sufficient to invoke the method. If the APIs Explorer shows an\nresult of 403, you have chosen an insufficient scope to invoke the method. Try\na broader scope.\n\nFor additional information on scope selection, refer to the authentication and\nauthorization section of documentation for your specific Google API.\n\n### Revoke authorized access to test with new scopes\n\nAfter you have used the Google authorization screen to approve authorization,\nthe APIs Explorer remains authorized to make authenticated requests as long\nas the credentials aren't expired. Unchecking scopes doesn't reset the\npreviously approved credentials and scopes. If you want to test with a new\nscope configuration, you must revoke your previously approved credentials.\n\nTo revoke the credentials used by the APIs Explorer:\n\n1. Navigate to [Apps with access to your account](https://www.google.com/accounts/IssuedAuthSubTokens).\n2. Under **Third-party apps with account access** , click **Google APIs Explorer**.\n3. Click **Remove Access**.\n4. (optional) Reload the documentation page to reset the APIs Explorer."]]
