Method: properties.list

Возвращает свойства дочернего элемента в рамках указанной родительской учетной записи.

Свойства будут исключены, если у вызывающей стороны нет доступа. Свойства, удаленные «мягким образом» (т.е. «удаленные из корзины»), исключаются по умолчанию. Возвращает пустой список, если соответствующие свойства не найдены.

HTTP-запрос

GET https://analyticsadmin.googleapis.com/v1alpha/properties

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры запроса

Параметры
filter

string

Обязательное поле. Выражение для фильтрации результатов запроса. Для фильтрации могут использоваться следующие поля: parent: (Имя ресурса родительской учетной записи/свойства) или ancestor: (Имя ресурса родительской учетной записи) или firebase_project: (Идентификатор или номер связанного проекта Firebase). Примеры фильтров:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

Необязательный параметр. Максимальное количество ресурсов для возврата. Сервис может вернуть меньше этого значения, даже если есть дополнительные страницы. Если параметр не указан, будет возвращено не более 50 ресурсов. Максимальное значение — 200 (более высокие значения будут принудительно приведены к максимальному значению).

pageToken

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова properties.list . Укажите его, чтобы получить следующую страницу. При постраничной навигации все остальные параметры, предоставленные properties.list , должны соответствовать вызову, который предоставил токен страницы.

showDeleted

boolean

Следует ли включать в результаты свойства, удаленные «мягким образом» (т.е. «перенесенные в корзину»). Свойства можно проверить, чтобы определить, были ли они удалены или нет.

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Ответное сообщение для RPC-запроса properties.list.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "properties": [
    {
      object (Property)
    }
  ],
  "nextPageToken": string
}
Поля
properties[]

object ( Property )

Результаты, соответствующие критериям фильтра и доступные для звонящего.

nextPageToken

string

Токен, который можно отправить в качестве pageToken для получения следующей страницы. Если это поле опущено, последующих страниц не будет.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit