G Suite Alert Center API . v1beta1

Instance Methods

getSettings(customerId=None, x__xgafv=None)

Returns customer-level settings.

updateSettings(body, customerId=None, x__xgafv=None)

Updates the customer-level settings.

Method Details

getSettings(customerId=None, x__xgafv=None)
Returns customer-level settings.

Args:
  customerId: string, Optional. The unique identifier of the G Suite organization account of the
customer the alert settings are associated with.
Inferred from the caller identity if not provided.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Customer-level settings.
    "notifications": [ # The list of notifications.
      { # Settings for callback notifications.
          # For more details see [G Suite Alert
          # Notification](/admin-sdk/alertcenter/guides/notifications).
        "cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
            #
            # To register for notifications, the owner of the topic must grant
            # `alerts-api-push-notifications@system.gserviceaccount.com` the
            #  `projects.topics.publish` permission.
          "payloadFormat": "A String", # Optional. The format of the payload that would be sent.
              # If not specified the format will be JSON.
          "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
              # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
        },
      },
    ],
  }
updateSettings(body, customerId=None, x__xgafv=None)
Updates the customer-level settings.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # Customer-level settings.
  "notifications": [ # The list of notifications.
    { # Settings for callback notifications.
        # For more details see [G Suite Alert
        # Notification](/admin-sdk/alertcenter/guides/notifications).
      "cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
          #
          # To register for notifications, the owner of the topic must grant
          # `alerts-api-push-notifications@system.gserviceaccount.com` the
          #  `projects.topics.publish` permission.
        "payloadFormat": "A String", # Optional. The format of the payload that would be sent.
            # If not specified the format will be JSON.
        "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
            # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
      },
    },
  ],
}

  customerId: string, Optional. The unique identifier of the G Suite organization account of the
customer the alert settings are associated with.
Inferred from the caller identity if not provided.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Customer-level settings.
    "notifications": [ # The list of notifications.
      { # Settings for callback notifications.
          # For more details see [G Suite Alert
          # Notification](/admin-sdk/alertcenter/guides/notifications).
        "cloudPubsubTopic": { # A reference to a Cloud Pubsub topic. # A Google Cloud Pub/sub topic destination.
            #
            # To register for notifications, the owner of the topic must grant
            # `alerts-api-push-notifications@system.gserviceaccount.com` the
            #  `projects.topics.publish` permission.
          "payloadFormat": "A String", # Optional. The format of the payload that would be sent.
              # If not specified the format will be JSON.
          "topicName": "A String", # The `name` field of a Cloud Pubsub [Topic]
              # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
        },
      },
    ],
  }