Method: properties.reportingDataAnnotations.list

Répertoriez toutes les annotations des données de rapport d'une propriété.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource de l'établissement. Format: properties/property_id Exemple: properties/123

Paramètres de requête

Paramètres
filter

string

Facultatif. Filtre qui limite les annotations de données de rapport sous la propriété parente qui sont listées.

Les champs acceptés sont les suivants:

  • "name"
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

En outre, cette API fournit les fonctions d'assistance suivantes:

  • annotation_duration() : durée marquée par cette annotation, durée. attendez-vous à une représentation numérique des secondes suivie d'un suffixe s.
  • is_annotation_in_range(startDate, endDate) : si l'annotation se trouve dans la plage spécifiée par startDate et endDate. Les dates sont au format ISO-8601, par exemple 2031-06-28.

Opérations compatibles:

  • = : égal à
  • != : différent
  • < : inférieur à
  • > : supérieur à
  • <= : inférieur ou égal à
  • >= : supérieur ou égal à
  • : : opérateur "has"
  • =~ : correspondance avec une expression régulière
  • !~ : l'expression régulière ne correspond pas
  • NOT : négation logique
  • AND : "et" logique
  • OR : ou logique

Exemples :

  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

Facultatif. Nombre maximal de ressources à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur, même si des pages supplémentaires sont disponibles. Si aucune valeur n'est spécifiée, 50 ressources au maximum sont renvoyées. La valeur maximale est 200 (les valeurs supérieures sont réduites à la valeur maximale).
pageToken

string

Facultatif. Jeton de page reçu d'un appel reportingDataAnnotations.list précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à reportingDataAnnotations.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour l'appel RPC ListReportingDataAnnotation.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Champs
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Liste des annotations de données de rapport.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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