Google Site Verification API v1

Version: 5.3

Google Site Verification API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you programatically verify ownership of websites or domains with Google. Google documentation.

1 API Parameters

2 Resources

2.1 webResource

(require gapi/macro)

(require-gapi-doc siteVerification.v1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 webResource

procedure
(siteVerification-webResource-list [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get the list of your verified websites and domains.

procedure
(siteVerification-webResource-get #:id id
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get the most current data for a website or domain.

id: The id of a verified site or domain.

procedure
(siteVerification-webResource-insert
#:verificationMethod verificationMethod
[ #:id id
#:site site
#:owners owners
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  verificationMethod : string?
  id : string? = 'N/A
  site : string? = 'N/A
  owners : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Attempt verification of a website or domain.

verificationMethod: The method to use for verifying a site or domain.

id: 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.

site: The address and type of a site that is verified or will be verified.

owners: The email addresses of all verified owners.

procedure
(siteVerification-webResource-patch #:id id
[ #:site site
#:owners owners
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  site : string? = 'N/A
  owners : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Modify the list of owners for your website or domain. This method supports patch semantics.

id: The id of a verified site or domain.

site: The address and type of a site that is verified or will be verified.

owners: The email addresses of all verified owners.

procedure
(siteVerification-webResource-getToken
[ #:site site
#:verificationMethod verificationMethod
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  site : string? = 'N/A
  verificationMethod : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Get a verification token for placing on a website or domain.

site: The site for which a verification token will be generated.

verificationMethod: The verification method that will be used to verify this site. For sites, ’FILE’ or ’META’ methods may be used. For domains, only ’DNS’ may be used.

procedure
(siteVerification-webResource-delete
#:id id
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Relinquish ownership of a website or domain.

id: The id of a verified site or domain.

procedure
(siteVerification-webResource-update
#:id id
[ #:site site
#:owners owners
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  site : string? = 'N/A
  owners : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Modify the list of owners for your website or domain.

id: The id of a verified site or domain.

site: The address and type of a site that is verified or will be verified.

owners: The email addresses of all verified owners.