Enlaces de filtros de perfiles: list

Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Requiere autorización

Enumera todos los enlaces de filtro de perfil de un perfil. Pruébalo ahora o consulta un ejemplo.

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks

Parámetros

Nombre de parámetro Valor Descripción
Parámetros de ruta
accountId string ID de cuenta para el que se recuperarán los enlaces de filtro de perfil.
profileId string ID de perfil para el que se recuperarán los enlaces de filtro de perfil. Puede ser un ID de perfil específico o "~all", que hace referencia a todos los perfiles a los que tiene acceso el usuario.
webPropertyId string ID de propiedad web de los enlaces de filtro de perfil. Puede ser un ID de propiedad web específico o "~all", que hace referencia a todas las propiedades web a las que tiene acceso el usuario.
Parámetros de consulta opcionales
max-results integer Número máximo de enlaces de filtro de perfil que se incluirán en esta respuesta.
start-index integer Índice de la primera entidad que se recuperará. Utiliza este parámetro como un mecanismo de paginación junto con el parámetro max-results.

Autorización

Esta solicitud requiere autorización con al menos uno de los ámbitos siguientes. Más información sobre la autenticación y la autorización

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

Cuerpo de la solicitud

No proporciones un cuerpo de solicitud con este método.

Respuesta

Si este método se realiza correctamente, el cuerpo de respuesta tendrá la siguiente estructura:

{
  "kind": "analytics#profileFilterLinks",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.profileFilterLinks Resource
  ]
}
Nombre de propiedad Valor Descripción Notas
kind string Tipo de colección.
username string ID de correo electrónico del usuario autenticado.
totalResults integer Número total de resultados de la consulta, independientemente del número de resultados en la respuesta.
startIndex integer Índice inicial de los recursos, que es 1 de forma predeterminada o lo especificado por el parámetro de consulta start-index.
itemsPerPage integer Número máximo de recursos que puede contener la respuesta, independientemente del número real de recursos devueltos. Su valor está entre 1 y 1000, siendo 1000 el valor predeterminado o el especificado por el parámetro de consulta max-results.
items[] list Una lista de enlaces de filtro de perfil.

Ejemplos

Nota: Los ejemplos de código disponibles para este método no representan todos los lenguajes de programación admitidos (consulta la página de bibliotecas de cliente para obtener una lista de los lenguajes admitidos).

Java

Utiliza la biblioteca de cliente Java.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Filters Developer Guide for details.
 */

/*
 * Example #1:
 * Requests a list of all profile filter links for the authorized user.
 */
try {
  ProfileFilterLinks filterLinks = analytics.management().
      profileFilterLinks().list("123456", "UA-123456-1",
          "7654321").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/*
 * Example 2:
 * The results of the list method are stored in the filterLinks object.
 * The following code shows how to iterate through them.
 */
for (ProfileFilterLink link : filterLinks.getItems()) {
  System.out.println("Link Id = " + link.getId());
  System.out.println("Link Kind = " + link.getKind());

  // Get the profile reference.
  ProfileRef profileRef = link.getProfileRef();
  System.out.println("Profile Id = " + profileRef.getId());
  System.out.println("Profile Kind = " + profileRef.getKind());
  System.out.println("Profile Account Id = " + profileRef.getAccountId());
  System.out.println("Profile Property Id = " + profileRef.getWebPropertyId());
  System.out.println("Profile Name = " + profileRef.getName());

  // Get the filter reference.
  FilterRef filterRef = link.getFilterRef();
  System.out.println("Filter Id = " + filterRef.getId());
  System.out.println("Filter Account Id = " + filterRef.getAccountId());
  System.out.println("Filter Name = " + filterRef.getName());
}

Python

Utiliza la biblioteca de cliente Python.

# Note: This code assumes you have an authorized Analytics service object.
# See the Filters Developer Guide for details.

# Example #1:
# Requests a list of all profile filter links for the authorized user.
try:
  filterLinks = analytics.management().profileFilterLinks().list(
      accountId='123456'
      webPropertyId='UA-123456-1',
      profileId='7654321'
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# Example #2:
# The results of the list method are stored in the filterLinks object.
# The following code shows how to iterate through them.
for link in filterLinks.get('items', []):
  print 'Link Id = %s' % link.get('id')
  print 'Link Kind = %s' % link.get('kind')

  # Get the profile reference.
  profileRef = link.get('profileRef', {})
  print 'Profile Id = %s' % profileRef.get('id')
  print 'Profile Kind = %s' % profileRef.get('kind')
  print 'Profile Account Id = %s' % profileRef.get('accountId')
  print 'Profile Property Id = %s' % profileRef.get('webPropertyId')
  print 'Profile Name = %s' % profile.get('name')

  # Get the filter reference.
  filterRef = link.get('filterRef', {})
  print 'Filter Id = %s' % filterRef.get('id')
  print 'Filter Account Id = %s' % filterRef.get('accountId')
  print 'Filter Name = %s' % filterRef.get('name')

Pruébalo

Utiliza el siguiente explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta. También puedes probar el explorador independiente.