Method: properties.reportingDataAnnotations.list

Elenca tutte le annotazioni dei dati dei report in una proprietà.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Nome della risorsa della proprietà. Formato: properties/property_id Esempio: properties/123

Parametri di query

Parametri
filter

string

Facoltativo. Filtro che limita le annotazioni dei dati dei report elencate nella proprietà principale.

I campi supportati sono:

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

Inoltre, questa API fornisce le seguenti funzioni di supporto:

  • annotation_duration() : la durata contrassegnata da questa annotazione, durations. si aspetta una rappresentazione numerica dei secondi seguita da un suffisso s.
  • is_annotation_in_range(startDate, endDate) : se l'annotazione è nell'intervallo specificato da startDate e endDate. Le date sono nel formato ISO-8601, ad esempio 2031-06-28.

Operazioni supportate:

  • = : è uguale a
  • != : diverso da
  • < : minore di
  • > : maggiore di
  • <= : minore o uguale a
  • >= : maggiore o uguale a
  • : : operatore has
  • =~ : corrispondenza con espressione regolare
  • !~ : l'espressione regolare non corrisponde
  • NOT : NOT logico
  • AND : E logico
  • OR : operatore logico OR

Esempi:

  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

Facoltativo. Il numero massimo di risorse da restituire. Il servizio potrebbe restituire meno di questo valore, anche se sono presenti pagine aggiuntive. Se non specificato, verranno restituite al massimo 50 risorse. Il valore massimo è 200; i valori superiori verranno forzati al massimo
pageToken

string

Facoltativo. Un token di pagina ricevuto da una chiamata reportingDataAnnotations.list precedente. Fornisci questo valore per recuperare la pagina successiva. Quando viene applicata la paginazione, tutti gli altri parametri forniti a reportingDataAnnotations.list devono corrispondere alla chiamata che ha fornito il token pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per l'RPC ListReportingDataAnnotation.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Campi
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Elenco di annotazioni dei dati dei report.
nextPageToken

string

Un token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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