Method: properties.reportingDataAnnotations.list

Muestra una lista de todas las anotaciones de datos de informes de una propiedad.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso de la propiedad. Formato: properties/property_id Ejemplo: properties/123

Parámetros de consulta

Parámetros
filter

string

Opcional. Es un filtro que restringe qué anotaciones de datos de informes de la propiedad superior se incluyen en la lista.

Los campos admitidos son los siguientes:

  • 'name'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

Además, esta API proporciona las siguientes funciones auxiliares:

  • annotation_duration() : Es la duración que marca esta anotación, durations. espera una representación numérica de segundos seguida de un sufijo s.
  • is_annotation_in_range(startDate, endDate) : Indica si la anotación está dentro del rango especificado por startDate y endDate. Las fechas están en formato ISO-8601, por ejemplo, 2031-06-28.

Operaciones admitidas:

  • = : es igual a
  • != : No es igual
  • < : Menor que
  • > : Mayor que
  • <= : Menor o igual que
  • >= : Mayor o igual que
  • : : Operador tiene
  • =~ : Coincidencia de expresión regular
  • !~ : La expresión regular no coincide.
  • NOT : No lógico
  • AND : Operador lógico Y
  • OR : Operador lógico O

Ejemplos:

  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

Opcional. Es la cantidad máxima de recursos que se mostrarán. El servicio puede mostrar menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se mostrarán como máximo 50 recursos. El valor máximo es 200 (los valores más altos se convertirán al máximo).
pageToken

string

Opcional. Un token de página, recibido desde una llamada reportingDataAnnotations.list anterior. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados a reportingDataAnnotations.list deben guardar correspondencia con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para la RPC de ListReportingDataAnnotation.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Campos
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Es la lista de anotaciones de datos de informes.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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