Method: properties.reportingDataAnnotations.list

Перечислите все аннотации к данным отчетов для свойства.

HTTP-запрос

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

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

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

Параметры
parent

string

Необходимый. Имя ресурса свойства. Формат: свойства/property_id Пример: свойства/123

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

Параметры
filter

string

Необязательный. Фильтр, ограничивающий список аннотаций к данным отчетов в родительском свойстве.

Поддерживаемые поля:

  • 'имя'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Кроме того, этот API предоставляет следующие вспомогательные функции:

  • annotation_duration(): продолжительность, которую отмечает эта аннотация, длительность . ожидайте числовое представление секунд, за которым следует суффикс s .
  • is_annotation_in_range(startDate, endDate) : если аннотация находится в диапазоне, указанном startDate и endDate . Даты имеют формат ISO-8601, например 2031-06-28

Поддерживаемые операции:

  • = : равно
  • != : не равно
  • < : меньше чем
  • > : больше, чем
  • <= : меньше или равно
  • >= : больше или равно
  • : : имеет оператор
  • =~ : совпадение с регулярным выражением
  • !~ : регулярное выражение не соответствует
  • NOT : Логичное «нет».
  • AND : Логично и
  • OR : Логическое или

Примеры:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

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

pageToken

string

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

Тело запроса

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

Тело ответа

Ответное сообщение для RPC ListReportingDataAnnotation.

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

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

object ( ReportingDataAnnotation )

Список аннотаций к отчетным данным.

nextPageToken

string

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

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

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

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

Перечислите все аннотации к данным отчетов для свойства.

HTTP-запрос

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

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

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

Параметры
parent

string

Необходимый. Имя ресурса свойства. Формат: свойства/property_id Пример: свойства/123

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

Параметры
filter

string

Необязательный. Фильтр, ограничивающий список аннотаций к данным отчетов в родительском свойстве.

Поддерживаемые поля:

  • 'имя'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Кроме того, этот API предоставляет следующие вспомогательные функции:

  • annotation_duration(): продолжительность, которую отмечает эта аннотация, длительность . ожидайте числовое представление секунд, за которым следует суффикс s .
  • is_annotation_in_range(startDate, endDate) : если аннотация находится в диапазоне, указанном startDate и endDate . Даты имеют формат ISO-8601, например 2031-06-28

Поддерживаемые операции:

  • = : равно
  • != : не равно
  • < : меньше чем
  • > : больше, чем
  • <= : меньше или равно
  • >= : больше или равно
  • : : имеет оператор
  • =~ : совпадение с регулярным выражением
  • !~ : регулярное выражение не соответствует
  • NOT : Логичное «нет».
  • AND : Логично и
  • OR : Логическое или

Примеры:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

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

pageToken

string

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

Тело запроса

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

Тело ответа

Ответное сообщение для RPC ListReportingDataAnnotation.

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

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

object ( ReportingDataAnnotation )

Список аннотаций к отчетным данным.

nextPageToken

string

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

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

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

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

Перечислите все аннотации к данным отчетов для свойства.

HTTP-запрос

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

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

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

Параметры
parent

string

Необходимый. Имя ресурса свойства. Формат: свойства/property_id Пример: свойства/123

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

Параметры
filter

string

Необязательный. Фильтр, ограничивающий список аннотаций к данным отчетов в родительском свойстве.

Поддерживаемые поля:

  • 'имя'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Кроме того, этот API предоставляет следующие вспомогательные функции:

  • annotation_duration(): продолжительность, которую отмечает эта аннотация, длительность . ожидайте числовое представление секунд, за которым следует суффикс s .
  • is_annotation_in_range(startDate, endDate) : если аннотация находится в диапазоне, указанном startDate и endDate . Даты имеют формат ISO-8601, например 2031-06-28

Поддерживаемые операции:

  • = : равно
  • != : не равно
  • < : меньше чем
  • > : больше, чем
  • <= : меньше или равно
  • >= : больше или равно
  • : : имеет оператор
  • =~ : совпадение с регулярным выражением
  • !~ : регулярное выражение не соответствует
  • NOT : Логичное «нет».
  • AND : Логично и
  • OR : Логическое или

Примеры:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

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

pageToken

string

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

Тело запроса

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

Тело ответа

Ответное сообщение для RPC ListReportingDataAnnotation.

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

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

object ( ReportingDataAnnotation )

Список аннотаций к отчетным данным.

nextPageToken

string

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

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

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

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

Перечислите все аннотации к данным отчетов для свойства.

HTTP-запрос

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

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

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

Параметры
parent

string

Необходимый. Имя ресурса свойства. Формат: свойства/property_id Пример: свойства/123

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

Параметры
filter

string

Необязательный. Фильтр, ограничивающий список аннотаций к данным отчетов в родительском свойстве.

Поддерживаемые поля:

  • 'имя'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Кроме того, этот API предоставляет следующие вспомогательные функции:

  • annotation_duration(): продолжительность, которую отмечает эта аннотация, длительность . ожидайте числовое представление секунд, за которым следует суффикс s .
  • is_annotation_in_range(startDate, endDate) : если аннотация находится в диапазоне, указанном startDate и endDate . Даты имеют формат ISO-8601, например 2031-06-28

Поддерживаемые операции:

  • = : равно
  • != : не равно
  • < : меньше чем
  • > : больше, чем
  • <= : меньше или равно
  • >= : больше или равно
  • : : имеет оператор
  • =~ : совпадение с регулярным выражением
  • !~ : регулярное выражение не соответствует
  • NOT : Логичное «нет».
  • AND : Логично и
  • OR : Логическое или

Примеры:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

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

pageToken

string

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

Тело запроса

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

Тело ответа

Ответное сообщение для RPC ListReportingDataAnnotation.

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

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

object ( ReportingDataAnnotation )

Список аннотаций к отчетным данным.

nextPageToken

string

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

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

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

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