Merchant API . accounts . notificationsubscriptions

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

Args:
  parent: string, Required. The merchant account that owns the new notification subscription. Format: `accounts/{account}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a notification subscription owned by a Merchant account.
  "allManagedAccounts": True or False, # 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.
  "callBackUri": "A String", # URL to be used to push the notification to the merchant.
  "name": "A 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}`
  "registeredEvent": "A String", # The event that the merchant wants to be notified about.
  "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a notification subscription owned by a Merchant account.
  "allManagedAccounts": True or False, # 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.
  "callBackUri": "A String", # URL to be used to push the notification to the merchant.
  "name": "A 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}`
  "registeredEvent": "A String", # The event that the merchant wants to be notified about.
  "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
}

delete(name, x__xgafv=None)

Deletes a notification subscription for a merchant.

Args:
  name: string, Required. The name of the notification subscription to be deleted. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets notification subscriptions for an account.

Args:
  name: string, Required. The `name` of the notification subscription. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a notification subscription owned by a Merchant account.
  "allManagedAccounts": True or False, # 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.
  "callBackUri": "A String", # URL to be used to push the notification to the merchant.
  "name": "A 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}`
  "registeredEvent": "A String", # The event that the merchant wants to be notified about.
  "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Gets all the notification subscriptions for a merchant.

Args:
  parent: string, Required. The merchant account who owns the notification subscriptions. Format: `accounts/{account}` (required)
  pageSize: integer, 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`.
  pageToken: string, Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the ListNotificationSubscription method.
  "nextPageToken": "A 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.
  "notificationSubscriptions": [ # The list of notification subscriptions requested by the merchant.
    { # Represents a notification subscription owned by a Merchant account.
      "allManagedAccounts": True or False, # 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.
      "callBackUri": "A String", # URL to be used to push the notification to the merchant.
      "name": "A 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}`
      "registeredEvent": "A String", # The event that the merchant wants to be notified about.
      "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an existing notification subscription for a merchant.

Args:
  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}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a notification subscription owned by a Merchant account.
  "allManagedAccounts": True or False, # 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.
  "callBackUri": "A String", # URL to be used to push the notification to the merchant.
  "name": "A 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}`
  "registeredEvent": "A String", # The event that the merchant wants to be notified about.
  "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
}

  updateMask: string, List of fields being updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a notification subscription owned by a Merchant account.
  "allManagedAccounts": True or False, # 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.
  "callBackUri": "A String", # URL to be used to push the notification to the merchant.
  "name": "A 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}`
  "registeredEvent": "A String", # The event that the merchant wants to be notified about.
  "targetAccount": "A String", # The `name` of the account you want to receive notifications for. Format: `accounts/{account}`
}