Method: properties.reportingDataAnnotations.list

Wyświetla listę wszystkich adnotacji danych raportowania dotyczących usługi.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Nazwa zasobu usługi. Format: properties/property_id Przykład: properties/123

Parametry zapytania

Parametry
filter

string

Opcjonalnie: Filtr, który ogranicza listę adnotacji danych raportowania w usłudze nadrzędnej.

Obsługiwane pola:

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

Dodatkowo ten interfejs API udostępnia te funkcje pomocnicze:

  • annotation_duration() : czas trwania, który oznacza ta adnotacja, czasy trwania. oczekuje liczbowej reprezentacji sekund z sufiksem s.
  • is_annotation_in_range(startDate, endDate) : czy adnotacja znajduje się w zakresie określonym przez startDate i endDate. Daty są w formacie ISO-8601, np. 2031-06-28.

Obsługiwane operacje:

  • = : równa się
  • != : nierówność
  • < : mniej niż
  • > : większe niż
  • <= : mniejsze lub równe
  • >= : większe lub równe
  • : : ma operatora
  • =~ : dopasowanie wyrażenia regularnego
  • !~ : wyrażenie regularne nie pasuje
  • NOT : negacja logiczna
  • AND : operator logiczny i
  • OR : operator logiczny lub

Przykłady:

  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

Opcjonalnie: Maksymalna liczba zasobów do zwrócenia. Usługa może zwrócić mniej niż tę wartość, nawet jeśli są dodatkowe strony. Jeśli nie określisz inaczej, zwróci się maksymalnie 50 zasobów. Maksymalna wartość to 200 (wyższe wartości zostaną przymusowo ustawione na maksymalną).
pageToken

string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji reportingDataAnnotations.list. Podaj ten parametr, aby pobrać kolejną stronę. Podczas podziału na strony wszystkie inne parametry przekazane do funkcji reportingDataAnnotations.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Komunikat odpowiedzi dla wywołania RPC ListReportingDataAnnotation.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Pola
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Lista adnotacji danych do raportu.
nextPageToken

string

token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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