WebResource
Stay organized with collections
Save and categorize content based on your preferences.
A WebResource is a representation of a verified website or domain.
It contains the canonical ID of a site or domain, the URL or domain name, and a list of owners. Note that the owners list always includes the authenticated user, because the only people who can access a WebResource are authenticated users who are owners of that site or domain.
For a list of methods
for this resource, see the end of this page.
Resource representations
{
"id"
:
string
,
"site"
:
{
"type"
:
string
,
"identifier"
:
string
} ,
"owners"
:
[
string
]
}
Property name
Value
Description
Notes
id
string
The string used to identify this site. This value should be used in the id
portion of the REST URL for the get
, update
, and delete
operations.
owners[]
list
The email addresses of all direct, verified owners of this exact property. Indirect owners—for example verified owners of the containing domain—are not included in this list.
site
object
Container for the address and type of a site that is verified or will be verified.
site.
identifier
string
The site identifier, which takes different forms depending on the value of the type
property.
site.
type
string
The site type.Acceptable values are: - "
ANDROID_APP
": Set identifier
to an Android app URL. Example:
"android-app://com.google.android.youtube/"
- "
INET_DOMAIN
": Set identifier
to a domain name. Examples:
"www.example.com", "example.com" or "subdomain.example.com"
- "
SITE
": Set identifier
to a fully-qualified URL for your site root, ending in a / mark. Examples:
"https://www.example.com/" or "https://www.example.com/subsite/"
Methods
Use the insert
method to verify the authenticated user's ownership of a website or domain. Use the get
,
update
,
and
delete
methods to retrieve or modify a resource that has already been verified for the authenticated user.
You can see all verified resources for the authenticated user with list
, and you can get a token to place on the authenticated user's site with getToken
.
- delete
- Unverifies the user's ownership of a website or domain.
- get
- Retrieves the most current data for a website or domain.
- getToken
- Gets a verification token for the authenticated user to place on a website or domain.
- insert
- Verifies ownership of a website or domain.
- list
- Gets the list of the authenticated user's verified websites and domains.
- update
- Modifies the list of owners for a website or domain.
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-06-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-06-11 UTC."],[[["\u003cp\u003eA WebResource represents a verified website or domain and includes its ID, URL/domain, and a list of owners, which always includes the authenticated user.\u003c/p\u003e\n"],["\u003cp\u003eYou can verify ownership, retrieve, update, and delete WebResources using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eWebResource data includes an ID, owner list, and site information containing the identifier and type (e.g., website, Android app, domain).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esite.identifier\u003c/code\u003e can be a domain name, a URL, or an Android app URL depending on the \u003ccode\u003esite.type\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods are available to manage WebResources, including inserting (verifying ownership), retrieving data, updating owner lists, deleting, listing all verified resources, and getting a verification token.\u003c/p\u003e\n"]]],["A WebResource represents a verified website or domain, identified by an `id`, `site` (type and identifier), and a list of `owners`, which always includes the authenticated user. Key actions include using `insert` to verify ownership, `get`, `update`, and `delete` to manage existing resources, `list` to view verified sites, and `getToken` to obtain a verification token. Site `type` can be `ANDROID_APP`, `INET_DOMAIN`, or `SITE`, with corresponding identifier formats.\n"],null,["# WebResource\n\n\u003cbr /\u003e\n\nA WebResource is a representation of a verified website or domain.\n\n\u003cbr /\u003e\n\nIt contains the canonical ID of a site or domain, the URL or domain name, and a list of owners. Note that the owners list always includes the authenticated user, because the only people who can access a WebResource are authenticated users who are owners of that site or domain.\n\n\u003cbr /\u003e\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\n\u003cbr /\u003e\n\n```carbon\n{\n \"id\": string,\n \"site\": {\n \"type\": string,\n \"identifier\": string\n },\n \"owners\": [\n string\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|-------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `id` | `string` | The string used to identify this site. This value should be used in the \u003cvar class=\"apiparam\" translate=\"no\"\u003eid\u003c/var\u003e portion of the REST URL for the [get](/site-verification/v1/webResource/get), [update](/site-verification/v1/webResource/update), and [delete](/site-verification/v1/webResource/delete) operations. | |\n| `owners[]` | `list` | The email addresses of all direct, verified owners of this exact property. Indirect owners---for example verified owners of the containing domain---are not included in this list. | |\n| `site` | `object` | Container for the address and type of a site that is verified or will be verified. | |\n| site.`identifier` | `string` | The site identifier, which takes different forms depending on the value of the `type` property. | |\n| site.`type` | `string` | The site type. \u003cbr /\u003e Acceptable values are: - \"`ANDROID_APP`\": Set `identifier` to an Android app URL. **Example:** \"android-app://com.google.android.youtube/\" - \"`INET_DOMAIN`\": Set `identifier` to a domain name. **Examples:** \"www.example.com\", \"example.com\" or \"subdomain.example.com\" - \"`SITE`\": Set `identifier` to a fully-qualified URL for your site root, ending in a / mark. **Examples:** \"https://www.example.com/\" or \"https://www.example.com/subsite/\" | |\n\nMethods\n-------\n\n\u003cbr /\u003e\n\nUse the [insert](/site-verification/v1/webResource/insert) method to verify the authenticated user's ownership of a website or domain. Use the [get](/site-verification/v1/webResource/get), [update](/site-verification/v1/webResource/update), and [delete](/site-verification/v1/webResource/delete) methods to retrieve or modify a resource that has already been verified for the authenticated user.\n\nYou can see all verified resources for the authenticated user with [list](/site-verification/v1/webResource/list), and you can get a token to place on the authenticated user's site with [getToken](/site-verification/v1/webResource/getToken).\n\n\u003cbr /\u003e\n\n[delete](/site-verification/v1/webResource/delete)\n: Unverifies the user's ownership of a website or domain.\n\n[get](/site-verification/v1/webResource/get)\n: Retrieves the most current data for a website or domain.\n\n[getToken](/site-verification/v1/webResource/getToken)\n: Gets a verification token for the authenticated user to place on a website or domain.\n\n[insert](/site-verification/v1/webResource/insert)\n: Verifies ownership of a website or domain.\n\n[list](/site-verification/v1/webResource/list)\n: Gets the list of the authenticated user's verified websites and domains.\n\n[update](/site-verification/v1/webResource/update)\n: Modifies the list of owners for a website or domain."]]
