ListUnits

GET

/api/v2/units

Query Parameters

`pageSize`integer

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

Format: "int64"

`pageToken`string

A page token, received from a previous ListUnits call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUnits must match the call that provided the page token.

`filter`string

A Common Expression Language (CEL, https://github.com/google/cel-spec) filter string. Available tag variables are:

abbreviated_name
name
created_date
unit_id

`orderBy`string

How to order the retrieved campaigns. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name, created_date, and abbreviated_name. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,abbreviated_name"

curl -X GET "<API_URL>/api/v2/units?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "units": [
    {
      "unitId": "string",
      "abbreviatedName": "string"
    }
  ],
  "nextPageToken": "string"
}

Query Parameters

pageSizeinteger

pageTokenstring

filterstring

orderBystring

Response

`pageSize`integer

`pageToken`string

`filter`string

`orderBy`string