Method: properties.reportingDataAnnotations.list

Listar todas as anotações de dados de relatórios em uma propriedade.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome do recurso da propriedade. Formato: properties/property_id. Exemplo: properties/123

Parâmetros de consulta

Parâmetros
filter

string

Opcional. Filtro que restringe quais anotações de dados de relatórios na propriedade pai são listadas.

Os campos compatíveis são:

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

Além disso, essa API oferece as seguintes funções auxiliares:

  • annotation_duration() : a duração que essa anotação marca, durações. espera uma representação numérica de segundos seguida de um sufixo s.
  • is_annotation_in_range(startDate, endDate) : se a anotação estiver no intervalo especificado por startDate e endDate. As datas estão no formato ISO-8601, por exemplo, 2031-06-28.

Operações compatíveis:

  • = : igual a
  • != : não é igual
  • < : menor que
  • > : maior que
  • <= : menor que ou igual a
  • >= : maior que ou igual a
  • : : operador "tem"
  • =~ : correspondência de expressão regular
  • !~ : a expressão regular não corresponde
  • NOT : negação lógica
  • AND: "E" lógico
  • OR : Lógico ou

Exemplos:

  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. O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja outras páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.
pageToken

string

Opcional. Um token de página recebido de uma chamada reportingDataAnnotations.list anterior. Forneça isso para recuperar a página subsequente. Na paginação, todos os outros parâmetros enviados para reportingDataAnnotations.list precisam corresponder à chamada que proporcionou o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para o RPC ListReportingDataAnnotation.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
Campos
reportingDataAnnotations[]

object (ReportingDataAnnotation)

Lista de anotações de dados de relatórios.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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