Google search console

Learn how to use Google search console with Composio

Overview

SLUG: GOOGLE_SEARCH_CONSOLE

Description

Google Search Console provides tools to monitor, maintain, and troubleshoot your site’s presence in Google Search results.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to https://www.googleapis.com/auth/webmasters,https://www.googleapis.com/auth/webmasters.readonly,https://www.googleapis.com/auth/userinfo.profile,https://www.googleapis.com/auth/userinfo.email
bearer_token
string
token
stringRequired
bearer_token
stringRequired

Connecting to Google search console

Create an auth config

Use the dashboard to create an auth config for the Google search console toolkit. This allows you to connect multiple Google search console accounts to Composio for agents to use.

1

Select App

Navigate to [Google search console](https://platform.composio.dev?next_page=/marketplace/Google search console).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Google search console Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4google_search_console_auth_config_id = "ac_YOUR_GOOGLE_SEARCH_CONSOLE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Google search console: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, google_search_console_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using Bearer Token

1from composio import Composio
2
3# Auth config ID created above
4google_search_console_auth_config_id = "ac_YOUR_GOOGLE_SEARCH_CONSOLE_CONFIG_ID"
5
6# UUID from database/application
7user_id = "0000-0000-0000"
8
9composio = Composio()
10
11
12def authenticate_toolkit(user_id: str, auth_config_id: str):
13 # Replace this with a method to retrieve the Bearer Token from the user.
14 bearer_token = input("[!] Enter bearer token")
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
19 )
20 print(f"Successfully connected Google search console for user {user_id}")
21 print(f"Connection status: {connection_request.status}")
22
23 return connection_request.id
24
25
26connection_id = authenticate_toolkit(user_id, google_search_console_auth_config_id)
27
28# You can verify the connection using:
29connected_account = composio.connected_accounts.get(connection_id)
30print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Google search console toolkit’s playground](https://app.composio.dev/app/Google search console)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GOOGLE_SEARCH_CONSOLE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get Sitemap

Description

Retrieves information about a specific sitemap for a site.

Action Parameters

feedpath
stringRequired
site_url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Inspect URL

Description

Inspects a url for indexing issues and status in google search console.

Action Parameters

inspection_url
stringRequired
language_code
stringDefaults to en-US
site_url
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Sitemaps

Description

Lists all sitemaps for a site in google search console.

Action Parameters

site_url
stringRequired
sitemap_index
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Sites

Description

Lists all sites owned by the authenticated user in google search console.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Analytics Query

Description

Queries google search console for search analytics data including clicks, impressions, ctr, and position metrics.

Action Parameters

aggregation_type
stringDefaults to auto
data_state
stringDefaults to final
dimension_filter_groups
array
dimensions
arrayDefaults to ['query']
end_date
stringRequired
row_limit
integerDefaults to 1000
search_type
stringDefaults to web
site_url
stringRequired
start_date
stringRequired
start_row
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Submit Sitemap

Description

Submits a sitemap to google search console for indexing.

Action Parameters

feedpath
stringRequired
site_url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired