# Google Search Console

> Read search performance, inspect indexed URLs, and manage Search Console properties and sitemaps.

App · 10 actions. Web page: https://docs.lodol.com/docs/integrations/google-search-console

## Actions

### Add property

Add a property to your Search Console account. Ownership verification is separate.

**Inputs**

- Site url (`site_url`, text, required): Site url.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete sitemap

Delete sitemap in Google Search Console.

**Inputs**

- Site url (`site_url`, text, required): Site url.
- Sitemap url (`sitemap_url`, text, required): Sitemap url.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get property

Get site in Google Search Console.

**Inputs**

- Site url (`site_url`, text, required): Site url.

**Outputs**: Response.

- `data` (object): Contains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "permissionLevel": "SITE_PERMISSION_LEVEL_UNSPECIFIED",
    "siteUrl": "Example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get sitemap

Get sitemap in Google Search Console.

**Inputs**

- Site url (`site_url`, text, required): Site url.
- Sitemap url (`sitemap_url`, text, required): Sitemap url.

**Outputs**: Response.

- `data` (object): Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184).
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "contents": [],
    "errors": "Example",
    "isPending": false,
    "isSitemapsIndex": false,
    "lastDownloaded": "Example",
    "lastSubmitted": "Example",
    "path": "Example",
    "type": "NOT_SITEMAP",
    "warnings": "Example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Inspect URL

Inspect url in Google Search Console.

**Inputs**

- Inspection url (`inspection_url`, text): Page URL to inspect. Leave empty to inspect the property home page.
- Site url (`site_url`, text, required): Site url.
- Language code (`language_code`, text): Language code.

**Outputs**: Response.

- `data` (object): Index-Status inspection response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "inspectionResult": {
      "ampResult": {
        "ampIndexStatusVerdict": "VERDICT_UNSPECIFIED",
        "ampUrl": "Example",
        "indexingState": "AMP_INDEXING_STATE_UNSPECIFIED",
        "issues": [],
        "lastCrawlTime": "Example",
        "pageFetchState": "PAGE_FETCH_STATE_UNSPECIFIED",
        "robotsTxtState": "ROBOTS_TXT_STATE_UNSPECIFIED",
        "verdict": "VERDICT_UNSPECIFIED"
      },
      "indexStatusResult": {
        "coverageState": "Example",
        "crawledAs": "CRAWLING_USER_AGENT_UNSPECIFIED",
        "googleCanonical": "Example",
        "indexingState": "INDEXING_STATE_UNSPECIFIED",
        "lastCrawlTime": "Example",
        "pageFetchState": "PAGE_FETCH_STATE_UNSPECIFIED",
        "referringUrls": [],
        "robotsTxtState": "ROBOTS_TXT_STATE_UNSPECIFIED",
        "sitemap": [],
        "userCanonical": "Example",
        "verdict": "VERDICT_UNSPECIFIED"
      },
      "inspectionResultLink": "Example",
      "mobileUsabilityResult": {
        "issues": [],
        "verdict": "VERDICT_UNSPECIFIED"
      },
      "richResultsResult": {
        "detectedItems": [],
        "verdict": "VERDICT_UNSPECIFIED"
      }
    }
  },
  "has_more": false,
  "next_cursor": null
}
```

### List properties

List sites in Google Search Console.

**Inputs**: None.

**Outputs**: Response.

- `data` (object): List of sites with access level information.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "siteEntry": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### List sitemaps

List sitemaps in Google Search Console.

**Inputs**

- Site url (`site_url`, text, required): Site url.

**Outputs**: Response.

- `data` (object): List of sitemaps.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "sitemap": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Query search analytics

Query search analytics in Google Search Console.

**Inputs**

- Site url (`site_url`, text, required): Site url.
- Start date (`start_date`, date, required): Start date.
- End date (`end_date`, date, required): End date.
- Dimensions (`dimensions`, list): Dimensions. One or more of: `date`, `hour`, `query`, `page`, `country`, `device`, `searchAppearance`.
- Search type (`search_type`, text): Search type. One of: `web`, `image`, `video`, `news`, `discover`, `googleNews`.
- Data state (`data_state`, text): Data state. One of: `final`, `all`, `hourly_all`.
- Aggregation type (`aggregation_type`, text): Aggregation type. One of: `auto`, `byPage`, `byProperty`.
- Row limit (`row_limit`, number): Row limit. At least 1.
- Start row (`start_row`, number): Start row. At least 0.
- Dimension filters (`dimension_filters`, list): Dimension filters.

**Outputs**: Response.

- `data` (object): A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {
    "metadata": {
      "firstIncompleteDate": "Example",
      "firstIncompleteHour": "Example"
    },
    "responseAggregationType": "AUTO",
    "rows": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Remove property

Remove a property from your account. This does not delete its website.

**Inputs**

- Site url (`site_url`, text, required): Site url.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Submit sitemap

Submit sitemap in Google Search Console.

**Inputs**

- Site url (`site_url`, text, required): Site url.
- Sitemap url (`sitemap_url`, text, required): Sitemap url.

**Outputs**: Response.

- `data` (object): The official API response, including records and response metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token or offset to pass to the next request.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```
