Get started with Search Researcher Result (SRR) API

1. Sign in to the Google Account that was used to request access to the Search Researcher Result API.
2. To begin, you must be approved to use the Search Researcher Result API and have received an email with the Project ID.
3. Go to https://console.cloud.google.com.
4. If displayed, accept the Google Cloud Console Terms of Services.
5. At the top left, click Select a project.
   1. To create a new project:
      1. At the top right of the pop-up window, click NEW PROJECT.
      2. Enter a name for the project.
      3. Select the location you want to place the project.
      4. At the bottom right, click Create.
   2. To select an existing project:
      1. To find the project you want to open, use the search bar or navigate the folder.
      2. Click the project that you want.
      3. At the bottom right, click Open.

1. In a new tab, go to https://console.cloud.google.com/apis/library/searchresearcherresults.googleapis.com.
2. To turn on the Search Researcher Result API, click Enable.

1. In a new tab, go to https://developers.google.com/oauthplayground.
2. In the section “Step 1 Select & Authorize APIs,” enter this string in the text field: “https://googleapis.com/auth/searchresearcherresults.researcherProject.readonly”.
3. At the bottom right, click Authorize APIs.
4. In the screen that displays, click Allow.
5. Click Exchange authorization code for tokens.

1. From the application approval email you received, copy your Project ID.
2. In the section “Step 3 Configure request to API,” set the parameters:
   • HTTP Method = POST Request
   • Request URI = "https://searchresearcherresults.googleapis.com/v1/researcherprojects/{ADD YOUR PROJECT ID HERE}:runQuery"

3. Click Enter request body and enter your query parameters “Request Body,” with the format "query": "/search?q={ADD YOUR QUERY HERE}".
   Tip: For more information on how to format queries, go to How to format queries.

4. Click Send the Request.
5. In the left panel, check your result:
   • If the request is successful, the result begins with “HTTP/ 1.1 200 OK”.
   • If the request is unsuccessful, the result begins with “HTTP/ 1.1 403 FORBIDDEN”. Make sure you’re signed in with the same Google Account that was used to request access to the Search Researcher Result API.

The API expects one input field named query. The query field value must include the path of the search page you want to use. For example, If you want to search “Google” use the value /search?q=google to create the query https://google.com/search?q=google.

You can access the API with a curl request like this:

• Replace {OAuth Credential} with an OAuth token.
• Replace the number 1234 with your Project ID. 

If your query is successful, you’ll find a response like this in the htmlContent field:

Most requests that a browser makes to google.com with a path of /search? are supported with the same parameters that a browser issues through HTTP.

Common parameters include:

• &q= Query to execute a search for
• &gl= Specify a country or region
• &hl= Specify a language
• &start= Specify results past page one
• &tbm= Specify a search mode:

  • Supported values are isch, vid,bks, nws

• The SRR API returns a response in the htmlContent field. The HTML in the SRR response is the same as a request that originates from a browser. If you want to render the response in a browser, Chrome browser is the most compatible.
• When the response is rendered in a browser, some content that may be included in the response doesn’t display on the page. The content that doesn’t display in the browser includes external Javascript and some images.

• You can extract the content you want to use from either the HTML result or the page rendered in the browser.

Tip: Although SRR API requests are authenticated with your Google Account, your account information isn’t used to generate the HTML of the returned results page. The results page reflects a signed-out experience.