Class: Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb

Overview

Represents a notification subscription owned by a Merchant account.

Defined Under Namespace

Modules: NotificationEventType

Instance Attribute Summary collapse

Instance Attribute Details

#all_managed_accounts ⇒ ::Boolean

Returns If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.

Note: The following fields are mutually exclusive: all_managed_accounts, target_account. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Boolean) —

    If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.

    Note: The following fields are mutually exclusive: all_managed_accounts, target_account. If a field in that set is populated, all other fields in the set will automatically be cleared.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb', line 128

class NotificationSubscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the event type that the merchant is interested in receiving
  # notifications for.
  module NotificationEventType
    # Notifications event type is unspecified.
    NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0

    # Notification of product status changes, for example when product becomes
    # disapproved.
    PRODUCT_STATUS_CHANGE = 1
  end
end

#call_back_uri ⇒ ::String

Returns URL to be used to push the notification to the merchant.

Returns:

  • (::String) —

    URL to be used to push the notification to the merchant.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb', line 128

class NotificationSubscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the event type that the merchant is interested in receiving
  # notifications for.
  module NotificationEventType
    # Notifications event type is unspecified.
    NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0

    # Notification of product status changes, for example when product becomes
    # disapproved.
    PRODUCT_STATUS_CHANGE = 1
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}.

Returns:

  • (::String) —

    Output only. The name of the notification configuration. Generated by the Content API upon creation of a new NotificationSubscription. The account represents the merchant ID of the merchant that owns the configuration. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb', line 128

class NotificationSubscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the event type that the merchant is interested in receiving
  # notifications for.
  module NotificationEventType
    # Notifications event type is unspecified.
    NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0

    # Notification of product status changes, for example when product becomes
    # disapproved.
    PRODUCT_STATUS_CHANGE = 1
  end
end

#registered_event ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription::NotificationEventType

Returns The event that the merchant wants to be notified about.

Returns:



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb', line 128

class NotificationSubscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the event type that the merchant is interested in receiving
  # notifications for.
  module NotificationEventType
    # Notifications event type is unspecified.
    NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0

    # Notification of product status changes, for example when product becomes
    # disapproved.
    PRODUCT_STATUS_CHANGE = 1
  end
end

#target_account ⇒ ::String

Returns The name of the account you want to receive notifications for. Format: accounts/{account}

Note: The following fields are mutually exclusive: target_account, all_managed_accounts. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The name of the account you want to receive notifications for. Format: accounts/{account}

    Note: The following fields are mutually exclusive: target_account, all_managed_accounts. If a field in that set is populated, all other fields in the set will automatically be cleared.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'proto_docs/google/shopping/merchant/notifications/v1beta/notificationsapi.rb', line 128

class NotificationSubscription
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents the event type that the merchant is interested in receiving
  # notifications for.
  module NotificationEventType
    # Notifications event type is unspecified.
    NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0

    # Notification of product status changes, for example when product becomes
    # disapproved.
    PRODUCT_STATUS_CHANGE = 1
  end
end