Sites
Stay organized with collections
Save and categorize content based on your preferences.
For a list of methods for this resource, see the end of this page.
Resource representations
Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.
{
"siteUrl": string,
"permissionLevel": string
}
| Property name |
Value |
Description |
Notes |
permissionLevel |
string |
The user's permission level for the site.
Acceptable values are:
- "
siteFullUser"
- "
siteOwner"
- "
siteRestrictedUser"
- "
siteUnverifiedUser"
|
|
siteUrl |
string |
The URL of the property to add. Examples:
http://www.example.com/ (for a URL-prefix property) or
sc-domain:example.com (for a Domain property)
|
|
Methods
- add
- Adds a site to the set of the user's sites in Search Console.
- delete
- Removes a site from the set of the user's Search Console sites.
- get
- Retrieves information about specific site.
- list
- Lists the user's Search Console sites.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-23 UTC.
[null,null,["Last updated 2024-07-23 UTC."],[[["\u003cp\u003eThis resource outlines site permission levels within Google Search Console, including details on ownership, full user, restricted user, and unverified user roles.\u003c/p\u003e\n"],["\u003cp\u003eIt provides structured data representation with properties like \u003ccode\u003esiteUrl\u003c/code\u003e and \u003ccode\u003epermissionLevel\u003c/code\u003e to manage Search Console sites.\u003c/p\u003e\n"],["\u003cp\u003eUsers can utilize provided methods (add, delete, get, list) for managing their websites within Google Search Console via the API.\u003c/p\u003e\n"],["\u003cp\u003eThis information assists developers in programmatically interacting with Search Console to retrieve site data and manage site settings based on user permissions.\u003c/p\u003e\n"]]],["This resource details Search Console site information, including `siteUrl` and `permissionLevel`. Permission levels include `siteFullUser`, `siteOwner`, `siteRestrictedUser`, and `siteUnverifiedUser`. Key actions (methods) include `add` to add a site, `delete` to remove a site, `get` to retrieve site information, and `list` to show the user's sites. The `siteUrl` property is provided for both URL-prefix and Domain properties.\n"],null,["# Sites\n\n\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n------------------------\n\nContains permission level information about a Search Console site. For more information, see [Permissions in Search Console](https://support.google.com/webmasters/answer/2451999).\n\n```text\n{\n \"siteUrl\": string,\n \"permissionLevel\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|-------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `permissionLevel` | `string` | The user's permission level for the site. \u003cbr /\u003e Acceptable values are: - \"`siteFullUser`\" - \"`siteOwner`\" - \"`siteRestrictedUser`\" - \"`siteUnverifiedUser`\" | |\n| `siteUrl` | `string` | The URL of the property to add. **Examples:** `http://www.example.com/` (for a URL-prefix property) or `sc-domain:example.com` (for a Domain property) | |\n\nMethods\n-------\n\n[add](/webmaster-tools/v1/sites/add)\n: Adds a site to the set of the user's sites in Search Console.\n\n[delete](/webmaster-tools/v1/sites/delete)\n: Removes a site from the set of the user's Search Console sites.\n\n[get](/webmaster-tools/v1/sites/get)\n: Retrieves information about specific site.\n\n[list](/webmaster-tools/v1/sites/list)\n: Lists the user's Search Console sites."]]
