google_api_webmaster

v0.2.0

google_api_webmaster v0.2.0 GoogleApi.Webmaster.V3.Api.Sites View Source

API calls for all endpoints tagged Sites.

Link to this section Summary

Functions

webmasters_sites_add(connection, site_url, optional_params \\ [], opts \\ [])

Adds a site to the set of the user's sites in Search Console

webmasters_sites_delete(connection, site_url, optional_params \\ [], opts \\ [])

Removes a site from the set of the user's Search Console sites

webmasters_sites_get(connection, site_url, optional_params \\ [], opts \\ [])

Retrieves information about specific site

webmasters_sites_list(connection, optional_params \\ [], opts \\ [])

Lists the user's Search Console sites

Link to this section Functions

Link to this function webmasters_sites_add(connection, site_url, optional_params \\ [], opts \\ []) View Source

Adds a site to the set of the user's sites in Search Console.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String.t): The URL of the site to add.

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function webmasters_sites_delete(connection, site_url, optional_params \\ [], opts \\ []) View Source

Removes a site from the set of the user's Search Console sites.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String.t): The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function webmasters_sites_get(connection, site_url, optional_params \\ [], opts \\ []) View Source

Retrieves information about specific site.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server
  • site_url (String.t): The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Webmaster.V3.Model.WmxSite{}} on success {:error, info} on failure

Link to this function webmasters_sites_list(connection, optional_params \\ [], opts \\ []) View Source

Lists the user's Search Console sites.

Parameters

  • connection (GoogleApi.Webmaster.V3.Connection): Connection to server

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %GoogleApi.Webmaster.V3.Model.SitesListResponse{}} on success {:error, info} on failure