Package google.shopping.merchant.notifications.v1beta

Index

• NotificationsApiService (interface)
• Attribute (enum)
• CreateNotificationSubscriptionRequest (message)
• DeleteNotificationSubscriptionRequest (message)
• GetNotificationSubscriptionRequest (message)
• ListNotificationSubscriptionsRequest (message)
• ListNotificationSubscriptionsResponse (message)
• NotificationSubscription (message)
• NotificationSubscription.NotificationEventType (enum)
• ProductChange (message)
• ProductStatusChangeMessage (message)
• Resource (enum)
• UpdateNotificationSubscriptionRequest (message)

NotificationsApiService

Service to manage notification subscriptions for merchants

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription) Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For MCAs, the business can create a subscription for all managed accounts or for a specific subaccount. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): Subscription for all managed accounts + subscription for self. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): Multiple self subscriptions. Multiple "all managed accounts" subscriptions. "All managed accounts" subscription and partial subscriptions at the same time. Multiple partial subscriptions for the same target account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

DeleteNotificationSubscription
rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty) Deletes a notification subscription for a merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

GetNotificationSubscription
rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription) Gets notification subscriptions for an account. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListNotificationSubscriptions
rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse) Gets all the notification subscriptions for a merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateNotificationSubscription
rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription) Updates an existing notification subscription for a merchant. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

Attribute

Enum to specify the attribute in the resource that is being changed to notify the merchant about.

Enums
ATTRIBUTE_UNSPECIFIED	Unspecified attribute
STATUS	Status of the changed entity

CreateNotificationSubscriptionRequest

Request message for the CreateNotificationSubscription method.

Fields
parent	string Required. The merchant account that owns the new notification subscription. Format: accounts/{account}
notification_subscription	NotificationSubscription Required. The notification subscription to create.

DeleteNotificationSubscriptionRequest

Request message for the DeleteNotificationSubscription method.

Fields
name	string Required. The name of the notification subscription to be deleted.

GetNotificationSubscriptionRequest

Request message for the GetNotificationSubscription method.

Fields
name	string Required. The name of the notification subscription.

ListNotificationSubscriptionsRequest

Request message for the ListNotificationSubscription method.

Fields
parent	string Required. The merchant account who owns the notification subscriptions. Format: accounts/{account}
page_size	int32 The maximum number of notification subscriptions to return in a page. The default value for page_size is 100. The maximum value is 200. Values above 200 will be coerced to 200.
page_token	string Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

ListNotificationSubscriptionsResponse

Response message for the ListNotificationSubscription method.

Fields
notification_subscriptions[]	NotificationSubscription The list of notification subscriptions requested by the merchant.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

NotificationSubscription

Represents a notification subscription owned by a Merchant account.

Fields
name	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}
registered_event	NotificationEventType The event that the merchant wants to be notified about.
call_back_uri	string URL to be used to push the notification to the merchant.
Union field interested_in. interested_in can be only one of the following:
all_managed_accounts	bool 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.
target_account	string The name of the account you want to receive notifications for. Format: accounts/{account}

NotificationEventType

Represents the event type that the merchant is interested in receiving notifications for.

Enums
NOTIFICATION_EVENT_TYPE_UNSPECIFIED	Notifications event type is unspecified.
PRODUCT_STATUS_CHANGE	Notification of product status changes, for example when product becomes disapproved.

ProductChange

The change that happened to the product including old value, new value, country code as the region code and reporting context.

Fields
old_value	string The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (approved, pending, disapproved, ``)
new_value	string The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (approved, pending, disapproved, ``)
region_code	string Countries that have the change (if applicable). Represented in the ISO 3166 format.
reporting_context	ReportingContextEnum Reporting contexts that have the change (if applicable). Currently this field supports only (SHOPPING_ADS, LOCAL_INVENTORY_ADS, YOUTUBE_SHOPPING, YOUTUBE_CHECKOUT, YOUTUBE_AFFILIATE) from the enum value ReportingContextEnum

ProductStatusChangeMessage

The message that the merchant will receive to notify about product status change event

Fields
changes[]	ProductChange A message to describe the change that happened to the product
account	string The target account that owns the entity that changed. Format : accounts/{merchant_id}
managing_account	string The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : accounts/{service_provider_id}
resource_type	Resource The resource that changed, in this case it will always be Product.
attribute	Attribute The attribute in the resource that changed, in this case it will be always Status.
resource_id	string The product id.
resource	string The product name. Format: accounts/{account}/products/{product}
expiration_time	Timestamp Optional. The product expiration time. This field will not bet set if the notification is sent for a product deletion event.
event_time	Timestamp The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.

Resource

Enum to specify the resource that is being changed to notify the merchant about.

Enums
RESOURCE_UNSPECIFIED	Unspecified resource
PRODUCT	Resource type : product

UpdateNotificationSubscriptionRequest

Request message for the UpdateNotificationSubscription method.

Fields
notification_subscription	NotificationSubscription Required. The new version of the notification subscription that should be updated.
update_mask	FieldMask List of fields being updated.