Method: organizations.locations.notifications.list

Stay organized with collections Save and categorize content based on your preferences.

Lists notifications under a given parent.

HTTP request

GET https://advisorynotifications.googleapis.com/v1/{parent=organizations/*/locations/*}/notifications

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}".

Query parameters

Parameters
pageSize

integer

The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.

pageToken

string

A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.

view

enum (NotificationView)

Specifies which parts of the notification resource should be returned in the response.

languageCode

string

ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response of ListNotifications endpoint.

JSON representation
{
  "notifications": [
    {
      object (Notification)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
notifications[]

object (Notification)

List of notifications under a given parent.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

totalSize

integer

Estimation of a total number of notifications.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • advisorynotifications.notifications.list

For more information, see the IAM documentation.

NotificationView

Notification view.

Enums
NOTIFICATION_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
BASIC Server responses only include title, creation time and Notification ID. Note: for internal use responses also include the last update time, the latest message text and whether notification has attachments.
FULL Include everything.