Method: properties.list

Devuelve las propiedades secundarias de la cuenta principal especificada.

Las propiedades se excluirán si el llamador no tiene acceso. Las propiedades borradas de forma no definitiva (es decir, "enviadas a la papelera") se excluyen de forma predeterminada. Devuelve una lista vacía si no se encuentran propiedades relevantes.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
filter

string

Obligatorio. Es una expresión para filtrar los resultados de la solicitud. Los campos aptos para filtrar son: parent:(el nombre del recurso de la cuenta o propiedad principal), ancestor:(el nombre del recurso de la cuenta principal) o firebase_project:(el ID o número del proyecto de Firebase vinculado). Estos son algunos ejemplos 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

Opcional. Es la cantidad máxima de recursos que se devolverán. El servicio puede devolver menos que este valor, incluso si hay páginas adicionales. Si no se especifica, se devolverán, como máximo, 50 recursos. El valor máximo es 200 (los valores más altos se convertirán al máximo).
pageToken

string

Opcional. Un token de página, recibido desde una llamada properties.list anterior. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados a properties.list deben guardar correspondencia con la llamada que proporcionó el token de la página.
showDeleted

boolean

Indica si se deben incluir en los resultados las propiedades borradas de forma no definitiva (es decir, "enviadas a la papelera"). Se pueden inspeccionar las propiedades para determinar si se borraron o no.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es el mensaje de respuesta para la RPC de properties.list.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "properties": [
    {
      object (Property)
    }
  ],
  "nextPageToken": string
}
Campos
properties[]

object (Property)

Son los resultados que coincidieron con los criterios del filtro y a los que el llamador pudo acceder.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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