Method: properties.list

Retorna propriedades filhas da conta principal especificada.

Somente as propriedades "GA4" serão retornadas. As propriedades serão excluídas se o autor da chamada não tiver acesso. As propriedades de exclusão reversível (ou seja, "lixeira") são excluídas por padrão. Retorna uma lista vazia se nenhuma propriedade relevante for encontrada.

Solicitação HTTP

GET https://analyticsadmin.googleapis.com/v1beta/properties

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

Parâmetros de consulta

Parâmetros
filter

string

Obrigatório. Uma expressão para filtrar os resultados da solicitação. Os campos qualificados para filtragem são: parent:(o nome do recurso da conta/propriedade pai) ou ancestor:(o nome do recurso da conta pai) ou firebase_project:(o código ou número do projeto do Firebase vinculado). Alguns exemplos de filtros:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
pageSize

integer

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo se houver páginas adicionais. Se não for especificado, serão retornados no máximo 50 recursos. O valor máximo é 200 (valores maiores são convertidos no máximo).
pageToken

string

Um token de página recebido de uma chamada properties.list anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para properties.list precisam corresponder à chamada que forneceu o token da página.
showDeleted

boolean

Indica se propriedades excluídas (ou seja, "lixadas") serão excluídas nos resultados. As propriedades podem ser inspecionadas para determinar se foram excluídas ou não.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para properties.list RPC.

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

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

object (Property)

Resultados que correspondem aos critérios do filtro e são acessíveis ao autor da chamada.
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 de OAuth:

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