View Source GoogleApi.Indexing.V3.Api.UrlNotifications (google_api_indexing v0.10.1)

API calls for all endpoints tagged UrlNotifications.

Summary

Functions

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

Gets metadata about a Web Document. This method can only be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest UrlNotification received via this API.

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

Notifies that a URL has been updated or deleted.

Functions

Link to this function

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

View Source 
@spec indexing_url_notifications_get_metadata(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Indexing.V3.Model.UrlNotificationMetadata.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata about a Web Document. This method can only be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest UrlNotification received via this API.

Parameters

  • connection (type: GoogleApi.Indexing.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :url (type: String.t) - URL that is being queried.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Indexing.V3.Model.UrlNotificationMetadata{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec indexing_url_notifications_publish(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Indexing.V3.Model.PublishUrlNotificationResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Notifies that a URL has been updated or deleted.

Parameters

  • connection (type: GoogleApi.Indexing.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Indexing.V3.Model.UrlNotification.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Indexing.V3.Model.PublishUrlNotificationResponse{}} on success
  • {:error, info} on failure