View Source GoogleApi.MyBusinessNotifications.V1.Api.Accounts (google_api_my_business_notifications v0.2.1)

API calls for all endpoints tagged Accounts.

Summary

Functions

Sets the pubsub notification setting for the account informing Google which topic to send pubsub notifications for. Use the notification_types field within notification_setting to manipulate the events an account wants to subscribe to. An account will only have one notification setting resource, and only one pubsub topic can be set. To delete the setting, update with an empty notification_types

Functions

Link to this function

mybusinessnotifications_accounts_get_notification_setting(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec mybusinessnotifications_accounts_get_notification_setting(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessNotifications.V1.Model.NotificationSetting.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the pubsub notification settings for the account.

Parameters

  • connection (type: GoogleApi.MyBusinessNotifications.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the notification setting we are trying to fetch.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessNotifications.V1.Model.NotificationSetting{}} on success
  • {:error, info} on failure
Link to this function

mybusinessnotifications_accounts_update_notification_setting(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec mybusinessnotifications_accounts_update_notification_setting(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MyBusinessNotifications.V1.Model.NotificationSetting.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the pubsub notification setting for the account informing Google which topic to send pubsub notifications for. Use the notification_types field within notification_setting to manipulate the events an account wants to subscribe to. An account will only have one notification setting resource, and only one pubsub topic can be set. To delete the setting, update with an empty notification_types

Parameters

  • connection (type: GoogleApi.MyBusinessNotifications.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name this setting is for. This is of the form accounts/{account_id}/notificationSetting.
  • 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").
    • :updateMask (type: String.t) - Required. The specific fields that should be updated. The only editable field is notification_setting.
    • :body (type: GoogleApi.MyBusinessNotifications.V1.Model.NotificationSetting.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MyBusinessNotifications.V1.Model.NotificationSetting{}} on success
  • {:error, info} on failure