Эта страница переведена с помощью Cloud Translation API.

Method: accounts.runAccessReport

HTTP-запрос
Параметры пути
Тело запроса
- JSON-представление
Тело ответа
Области авторизации
Попробуй это!

Возвращает настроенный отчет о записях доступа к данным. В отчете представлены записи каждый раз, когда пользователь читает данные отчетов Google Analytics. Записи о доступе хранятся до 2 лет.

Для объекта можно запросить отчеты о доступе к данным. Отчеты можно запрашивать для любого ресурса, однако параметры, не связанные с квотой, можно запрашивать только для ресурсов Google Analytics 360. Этот метод доступен только администраторам.

К этим записям доступа к данным относятся отчеты пользовательского интерфейса GA4, исследования пользовательского интерфейса GA4, API данных GA4 и другие продукты, такие как Firebase и Admob, которые могут получать данные из Google Analytics посредством связи. Эти записи не включают изменения конфигурации свойства, такие как добавление потока или изменение часового пояса свойства. Историю изменений конфигурации см. в разделе searchChangeHistoryEvents .

HTTP-запрос

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=accounts/*}:runAccessReport

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

Параметры пути

Параметры

Параметры
`entity`	`string` Отчет о доступе к данным поддерживает запросы на уровне ресурса или аккаунта. Если это запрошено на уровне аккаунта, отчеты о доступе к данным включают весь доступ ко всем ресурсам под этим аккаунтом. Чтобы запросить на уровне ресурса, объект должен иметь вид, например, «properties/123», если «123» — это идентификатор вашего ресурса GA4. Чтобы запросить на уровне учетной записи, сущность должна быть, например, «accounts/1234», если «1234» — это идентификатор вашей учетной записи GA4.

entity

string

Отчет о доступе к данным поддерживает запросы на уровне ресурса или аккаунта. Если это запрошено на уровне аккаунта, отчеты о доступе к данным включают весь доступ ко всем ресурсам под этим аккаунтом.

Чтобы запросить на уровне ресурса, объект должен иметь вид, например, «properties/123», если «123» — это идентификатор вашего ресурса GA4. Чтобы запросить на уровне учетной записи, сущность должна быть, например, «accounts/1234», если «1234» — это идентификатор вашей учетной записи GA4.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление

JSON-представление
{ "dimensions": [ { object (`AccessDimension`) } ], "metrics": [ { object (`AccessMetric`) } ], "dateRanges": [ { object (`AccessDateRange`) } ], "dimensionFilter": { object (`AccessFilterExpression`) }, "metricFilter": { object (`AccessFilterExpression`) }, "offset": string, "limit": string, "timeZone": string, "orderBys": [ { object (`AccessOrderBy`) } ], "returnEntityQuota": boolean, "includeAllUsers": boolean, "expandGroups": boolean }

{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}

Поля
`dimensions[]`	`object ( AccessDimension )` Размеры, запрошенные и отображенные в ответе. Запросы разрешены до 9 измерений.
`metrics[]`	`object ( AccessMetric )` Метрики, запрошенные и отображаемые в ответе. Запросы разрешены до 10 метрик.
`dateRanges[]`	`object ( AccessDateRange )` Диапазоны дат записей доступа для чтения. Если запрошено несколько диапазонов дат, каждая строка ответа будет содержать индекс диапазона дат, отсчитываемый от нуля. Если два диапазона дат перекрываются, записи доступа для перекрывающихся дней включаются в строки ответа для обоих диапазонов дат. Запросы разрешены до двух диапазонов дат.
`dimensionFilter`	`object ( AccessFilterExpression )` Фильтры измерений позволяют ограничить ответ отчета определенными значениями измерений, которые соответствуют фильтру. Например, фильтрация записей доступа одного пользователя. Дополнительные сведения см. в разделе «Основы фильтров измерений» . В этом фильтре нельзя использовать метрики.
`metricFilter`	`object ( AccessFilterExpression )` Фильтры метрик позволяют ограничить ответ отчета определенными значениями метрик, которые соответствуют фильтру. Фильтры метрик применяются после агрегирования строк отчета, аналогично оператору Have в SQL. В этом фильтре нельзя использовать размеры.
`offset`	`string ( int64 format)` Количество строк в начальной строке. Первая строка считается строкой 0. Если смещение не указано, оно рассматривается как 0. Если смещение равно нулю, этот метод вернет первую страницу результатов с `limit` записями. Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .
`limit`	`string ( int64 format)` Количество возвращаемых строк. Если не указано, возвращается 10 000 строк. API возвращает максимум 100 000 строк на запрос, независимо от того, сколько вы запрашиваете. `limit` должен быть положительным. API может вернуть меньше строк, чем запрошенное `limit` , если количество оставшихся строк не превышает установленное `limit` . Например, для параметра `country` существует менее 300 возможных значений, поэтому при составлении отчета только `country` вы не сможете получить более 300 строк, даже если вы установите `limit` на более высокое значение. Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .
`timeZone`	`string` Часовой пояс этого запроса, если он указан. Если не указано, используется часовой пояс объекта. Часовой пояс запроса используется для интерпретации дат начала и окончания отчета. Отформатировано как строки из базы данных часовых поясов IANA ( https://www.iana.org/time-zones) ; например «Америка/Нью-Йорк» или «Азия/Токио».
`orderBys[]`	`object ( AccessOrderBy )` Указывает, как упорядочены строки в ответе.
`returnEntityQuota`	`boolean` Переключает, возвращать ли текущее состояние квоты этого ресурса Analytics. Квота возвращается в AccessQuota . Для запросов на уровне учетной записи это поле должно быть ложным.
`includeAllUsers`	`boolean` Необязательный. Определяет, включать ли в ответ пользователей, которые никогда не совершали вызов API. Если значение равно true, в ответ включаются все пользователи, имеющие доступ к указанному ресурсу или учетной записи, независимо от того, выполнили ли они вызов API или нет. Если установлено значение false, будут включены только пользователи, выполнившие вызов API.
`expandGroups`	`boolean` Необязательный. Решает, следует ли возвращать пользователей в группы пользователей. Это поле работает только в том случае, если для параметра includeAllUsers установлено значение true. Если это правда, он вернет всех пользователей, имеющих доступ к указанному ресурсу или учетной записи. Если false, будут возвращены только пользователи с прямым доступом.

Тело ответа

В случае успеха тело ответа содержит экземпляр RunAccessReportResponse .

Области авторизации

Требуется одна из следующих областей OAuth:

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