Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Requisitos de autenticação da API Search Console
Toda solicitação que seu aplicativo envia para a API Google Search Console precisa incluir um token de autorização. O token também identifica o aplicativo para o Google.
Sobre os protocolos de autorização
O aplicativo deve obrigatoriamente usar o OAuth 2.0 para autorizar solicitações. Não há outros protocolos de autorização compatíveis. Se o aplicativo usa o Fazer login com o Google, alguns aspectos da autorização são administrados para você.
Autorizar solicitações com OAuth 2.0
Todas as solicitações para a API Google Search Console precisam ser autorizadas por um usuário autenticado.
Os detalhes do processo de autorização ou “fluxo” para o OAuth 2.0 variam um pouco, dependendo do tipo de aplicativo que você está criando. O processo geral a seguir se aplica a todos os tipos de aplicativo:
Ao criar seu aplicativo, registre-o usando o Console de APIs do Google. Em seguida, o Google fornece informações que serão usadas mais tarde, como um ID e uma chave secreta do cliente.
Ative a API Google Search Console no Console de APIs do Google. Se ela não estiver no Console de APIs, pule essa etapa.
Quando seu aplicativo precisar de acesso aos dados do usuário, ele solicitará ao Google um determinado escopo do acesso.
O Google exibe uma tela de consentimento ao usuário, pedindo para que o aplicativo seja autorizado a solicitar alguns dos dados dele.
Se o usuário aprovar, o Google fornecerá ao aplicativo um token de acesso de curta duração.
O aplicativo solicita dados de usuário, anexando o token de acesso à solicitação.
Se o Google determinar que a solicitação e o token são válidos, ele retornará os dados solicitados.
Alguns fluxos incluem etapas adicionais, como atualizar tokens para adquirir novos tokens de acesso. Para mais informações sobre fluxos de vários tipos de aplicativos, acesse a documentação OAuth 2.0 do Google.
Veja as informações de escopo do OAuth 2.0 para a API Google Search Console:
Para solicitar acesso usando o OAuth 2.0, você precisa das informações do escopo, bem como das informações fornecidas pelo Google durante o registro do aplicativo, como o ID e a chave secreta do cliente.
Dica: as bibliotecas cliente de APIs do Google cuidam de parte do processo de autorização para você. Elas estão disponíveis para uma série de linguagens de programação. Acesse a página de bibliotecas e exemplos para mais detalhes.
Requisitos de autenticação da API Search Console Testing Tools
Como receber e usar uma chave de API
As solicitações de dados públicos à API Search Console Testing Tools precisam ser acompanhadas por um identificador, que pode
ser uma chave de API ou um
token de acesso.
Essa API aceita dois tipos de credenciais.
Crie as credenciais apropriadas para seu projeto:
OAuth 2.0: sempre que seu aplicativo solicitar dados particulares do usuário, ele deverá enviar um token OAuth 2.0 junto da solicitação. Primeiro, seu aplicativo envia um ID de cliente e, possivelmente, uma chave secreta do cliente para obter um token. É possível gerar credenciais OAuth 2.0 para aplicativos da Web, contas de serviço ou aplicativos instalados.
Chaves de API: uma solicitação que não fornece um token OAuth 2.0 precisa enviar uma chave de API.
A chave identifica seu projeto e fornece acesso à API, à cota e aos relatórios.
A API é compatível com diversos tipos de restrições em chaves de API. Se a chave de API de que você precisa ainda não existe, crie uma no console. Para isso, clique em Criar credenciais
> Chave de API. É possível restringir a chave antes de usá-la na produção clicando em Restringir chave e selecionando uma das Restrições.
[[["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 2024-07-23 UTC."],[[["\u003cp\u003eAll applications must use OAuth 2.0 for authorization when interacting with the Google Search Console API to access user data.\u003c/p\u003e\n"],["\u003cp\u003eThe authorization process involves registering your application, obtaining necessary credentials, and requesting specific scopes of access, subject to user consent.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Search Console Testing Tools API requires an API key instead of an OAuth token to access its public data.\u003c/p\u003e\n"],["\u003cp\u003eAPI keys can be obtained and restricted for security via the Google API Console, while OAuth 2.0 is necessary for private user data requests.\u003c/p\u003e\n"]]],["Applications interacting with the Google Search Console API must use OAuth 2.0 for authorization. This involves registering the application with Google to obtain a client ID and secret. Applications request specific data access scopes, users grant consent, and then a short-lived access token is issued. The application then uses this token to request data. The Search Console Testing Tools API, however, requires an API key or an access token for requests, obtained via the Google API Console.\n"],null,["Search Console API auth requirements\n\nEvery request your application sends to the Google Search Console API must include an authorization token. The token also identifies your application to Google.\n\nAbout authorization protocols\n\nYour application must use [OAuth 2.0](https://developers.google.com/identity/protocols/OAuth2) to authorize requests. No other authorization protocols are supported. If your application uses [Sign In With Google](https://developers.google.com/identity/gsi/web), some aspects of authorization are handled for you.\n\nAuthorizing requests with OAuth 2.0\n\nAll requests to the Google Search Console API must be authorized by an authenticated user.\n\nThe details of the authorization process, or \"flow,\" for OAuth 2.0 vary somewhat depending on what kind of application you're writing. The following general process applies to all application types:\n\n1. When you create your application, you register it using the [Google API Console](https://console.cloud.google.com/). Google then provides information you'll need later, such as a client ID and a client secret.\n2. Activate the Google Search Console API in the Google API Console. (If the API isn't listed in the API Console, then skip this step.)\n3. When your application needs access to user data, it asks Google for a particular **scope** of access.\n4. Google displays a **consent screen** to the user, asking them to authorize your application to request some of their data.\n5. If the user approves, then Google gives your application a short-lived **access token**.\n6. Your application requests user data, attaching the access token to the request.\n7. If Google determines that your request and the token are valid, it returns the requested data.\n\nSome flows include additional steps, such as using **refresh tokens** to acquire new access tokens. For detailed information about flows for various types of applications, see Google's [OAuth 2.0 documentation](https://developers.google.com/identity/protocols/OAuth2).\n\nHere's the OAuth 2.0 scope information for the Google Search Console API:\n\n| Scope | Meaning |\n|-------------------------------------------------------|--------------------|\n| `https://www.googleapis.com/auth/webmasters` | Read/write access. |\n| `https://www.googleapis.com/auth/webmasters.readonly` | Read-only access. |\n\nTo request access using OAuth 2.0, your application needs the scope information, as well as\ninformation that Google supplies when you register your application (such as the client ID and the\nclient secret).\n\n**Tip:** The Google APIs client libraries can handle some of the authorization process for you. They are available for a variety of programming languages; check the [page with libraries and samples](/webmaster-tools/v1/libraries) for more details.\n\n*** ** * ** ***\n\nSearch Console Testing Tools API auth requirements **Note:** The Search Console Testing Tools API requires a key rather than an OAuth token.\n\nAcquiring and using an API key\n\nRequests to the Search Console Testing Tools API for public data must be accompanied by an identifier, which can\nbe an [API key](https://developers.google.com/console/help/generating-dev-keys) or an\n[access token](https://developers.google.com/accounts/docs/OAuth2).\n\nTo acquire an API key:\n\n1. Open the [Credentials page](https://console.cloud.google.com/apis/credentials) in the API Console.\n2. This API supports two types of credentials. Create whichever credentials are appropriate for your project:\n - **OAuth 2.0:** Whenever your application requests private user\n data, it must send an OAuth 2.0 token along with the request. Your\n application first sends a client ID and, possibly, a client secret to\n obtain a token. You can generate OAuth 2.0 credentials for web\n applications, service accounts, or installed applications.\n\n For more information, see the [OAuth 2.0 documentation](https://developers.google.com/identity/protocols/OAuth2).\n - **API keys:**\n\n A request that does not provide an OAuth 2.0 token must send an API\n key.\n\n The key identifies your project and provides API access, quota, and\n reports.\n\n The API supports several types of restrictions on API keys. If the API key that you\n need doesn't already exist, then create an API key in the Console by\n clicking **[Create credentials](https://console.cloud.google.com/apis/credentials) \\\u003e API key** . You can restrict the key before using it\n in production by clicking **Restrict key** and selecting one of the\n **Restrictions**.\n\nTo keep your API keys secure, follow the [best practices for\nsecurely using API keys](//cloud.google.com/docs/authentication/api-keys).\n\nAfter you have an API key, your application can append the query parameter\n`key=`\u003cvar translate=\"no\"\u003eyourAPIKey\u003c/var\u003e to all request URLs.\n\nThe API key is safe for embedding in URLs; it doesn't need any encoding."]]
