Method: properties.reportingDataAnnotations.list

Listet alle Vermerke zu Berichtsdaten für eine Property auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Ressourcenname der Property. Format: properties/property_id Beispiel: properties/123

Abfrageparameter

Parameter
filter

string

Optional. Mit diesem Filter wird eingeschränkt, welche Anmerkungen zu Berichtsdaten unter der übergeordneten Property aufgeführt werden.

Folgende Felder werden unterstützt:

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

Außerdem bietet diese API die folgenden Hilfsfunktionen:

  • annotation_duration() – die Dauer, die mit dieser Anmerkung gekennzeichnet ist, durations. erwartet eine numerische Darstellung von Sekunden, gefolgt von einem s-Suffix.
  • is_annotation_in_range(startDate, endDate) : Gibt an, ob sich die Anmerkung im durch startDate und endDate angegebenen Zeitraum befindet. Die Datumsangaben müssen dem Format ISO 8601 entsprechen, z. B. 2031-06-28.

Unterstützte Vorgänge:

  • = = entspricht
  • != : Nicht gleich
  • < : kleiner als
  • > : größer als
  • <= : kleiner als oder gleich
  • >= : größer als oder gleich
  • : : Operator „hat“
  • =~ : Übereinstimmung mit regulärem Ausdruck
  • !~ : Regulärer Ausdruck stimmt nicht überein
  • NOT : Logisches NOT
  • AND : Logisches AND
  • OR : Logisches OR

Beispiele:

  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

Optional. Die maximale Anzahl der zurückzugebenden Ressourcen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück, auch wenn es weitere Seiten gibt. Wenn nicht angegeben, werden maximal 50 Ressourcen zurückgegeben. Der Höchstwert ist 200. Höhere Werte werden auf den Höchstwert festgelegt.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen reportingDataAnnotations.list-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für reportingDataAnnotations.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für das RPC „ListReportingDataAnnotation“.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Felder
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Liste der Anmerkungen zu Berichtsdaten.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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