Method: properties.list

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

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

HTTP-запрос

GET https://analyticsadmin.googleapis.com/v1beta/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