Content API for Shopping . pubsubnotificationsettings

Instance Methods

get(merchantId)

Retrieves a Merchant Center account's pubsub notification settings.

update(merchantId, body=None)

Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.

Method Details

get(merchantId)
Retrieves a Merchant Center account's pubsub notification settings.

Args:
  merchantId: string, The ID of the account for which to get pubsub notification settings. (required)

Returns:
  An object of the form:

    { # Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. (== resource_for v2.1.pubsubnotificationsettings ==)
    "cloudTopicName": "A String", # Cloud pub/sub topic to which notifications are sent (read-only).
    "kind": "content#pubsubNotificationSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#pubsubNotificationSettings`"
    "registeredEvents": [ # List of event types.
        #
        # Acceptable values are:
        # - "`orderPendingShipment`"
      "A String",
    ],
  }
update(merchantId, body=None)
Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.

Args:
  merchantId: string, The ID of the account. (required)
  body: object, The request body.
    The object takes the form of:

{ # Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. (== resource_for v2.1.pubsubnotificationsettings ==)
  "cloudTopicName": "A String", # Cloud pub/sub topic to which notifications are sent (read-only).
  "kind": "content#pubsubNotificationSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#pubsubNotificationSettings`"
  "registeredEvents": [ # List of event types.
      # 
      # Acceptable values are:
      # - "`orderPendingShipment`"
    "A String",
  ],
}


Returns:
  An object of the form:

    { # Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. (== resource_for v2.1.pubsubnotificationsettings ==)
    "cloudTopicName": "A String", # Cloud pub/sub topic to which notifications are sent (read-only).
    "kind": "content#pubsubNotificationSettings", # Identifies what kind of resource this is. Value: the fixed string "`content#pubsubNotificationSettings`"
    "registeredEvents": [ # List of event types.
        #
        # Acceptable values are:
        # - "`orderPendingShipment`"
      "A String",
    ],
  }