2024-06-14
▼ ▲ merchantapi.accounts.notificationsubscriptions.get
Path: notifications/v1beta/{+name}
Flat Path: notifications/v1beta/accounts/{accountsId}/notificationsubscriptions/{notificationsubscriptionsId}
HTTP Method: GET
Parameters:
name
Description: Required. The `name` of the notification subscription.
Pattern: ^accounts/[^/]+/notificationsubscriptions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Gets notification subscriptions for an account.
▼ ▲ merchantapi.accounts.notificationsubscriptions.create
Path: notifications/v1beta/{+parent}/notificationsubscriptions
Flat Path: notifications/v1beta/accounts/{accountsId}/notificationsubscriptions
HTTP Method: POST
Parameters:
parent
Description: Required. The merchant account that owns the new notification subscription. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Creates a notification subscription for a merchant. We will allow the following types of notification subscriptions to exist together (per merchant as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self 2. Multiple "partial" subscriptions for managed accounts + subscription for self we will not allow (per merchant as a subscriber per event type): 1. multiple self subscriptions. 2. multiple "all managed accounts" subscriptions. 3. all and partial subscriptions at the same time. 4. multiple partial subscriptions for the same target account
▼ ▲ merchantapi.accounts.notificationsubscriptions.patch
Path: notifications/v1beta/{+name}
Flat Path: notifications/v1beta/accounts/{accountsId}/notificationsubscriptions/{notificationsubscriptionsId}
HTTP Method: PATCH
Parameters:
name
Description: 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}`
Pattern: ^accounts/[^/]+/notificationsubscriptions/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates an existing notification subscription for a merchant.
▼ ▲ merchantapi.accounts.notificationsubscriptions.delete
Path: notifications/v1beta/{+name}
Flat Path: notifications/v1beta/accounts/{accountsId}/notificationsubscriptions/{notificationsubscriptionsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the notification subscription to be deleted.
Pattern: ^accounts/[^/]+/notificationsubscriptions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Deletes a notification subscription for a merchant.
▼ ▲ merchantapi.accounts.notificationsubscriptions.list
Path: notifications/v1beta/{+parent}/notificationsubscriptions
Flat Path: notifications/v1beta/accounts/{accountsId}/notificationsubscriptions
HTTP Method: GET
Parameters:
parent
Description: Required. The merchant account who owns the notification subscriptions. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: 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`.
Location: query
Type: integer
Format: int32
pageToken
Description: Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Gets all the notification subscriptions for a merchant.