Vistas (perfiles): list

Requiere autorización

Enumera las vistas (perfiles) a las que tiene acceso el usuario. Pruébalo ahora o consulta un ejemplo.

Además de los parámetros estándar, este método admite los parámetros que se enumeran en la tabla correspondiente.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre de parámetro Valor Descripción
Parámetros de ruta
accountId string ID de cuenta de la vista (perfil) que se recuperará. Puede ser un ID de cuenta específico o "~all", que hace referencia a todas las cuentas a las que tiene acceso el usuario.
webPropertyId string ID de propiedad web de las vistas (perfiles) que se recuperarán. 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 vistas (perfiles) 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
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

La respuesta contiene un recurso Perfil por cada perfil solicitado.

{
  "kind": "analytics#profiles",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.profiles Resource
  ]
}
Nombre de propiedad Valor Descripción Notas
kind string Tipo de colección. El valor es "analytics#profiles".
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 Lista de vistas (perfiles).

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 View (Profile) Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of views (profiles) for the authorized user.
 */
try {
  Profiles profiles = analytics.management.profiles.list("12345",
      "UA-12345-1").execute();

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


/**
 * Example #2:
 * Retrieves views (profiles) for all properties of the user's account,
 * using a wildcard '~all' as the webpropertyId.
 */
Profiles profiles = analytics.management.profiles.list("12345",
    "~all").execute();


/**
 * Example #3:
 * The results of the list method are stored in the profiles object.
 * The following code shows how to iterate through them.
 */
for (Profile profile : profiles.getItems()) {
  System.out.println("Account ID: " + profile.getAccountId());
  System.out.println("Property ID: " + profile.getWebPropertyId());
  System.out.println("Property Internal ID: "
      + profile.getInternalWebPropertyId());
  System.out.println("View (Profile) ID: " + profile.getId());
  System.out.println("View (Profile) Name: " + profile.getName());
  System.out.println("View (Profile) defaultPage: " + profile.getDefaultPage());
  System.out.println("View (Profile) Exclude Query Parameters: "
      + profile.getExcludeQueryParameters());
  System.out.println("View (Profile) Site Search Query Parameters: "
      + profile.getSiteSearchQueryParameters());
  System.out.println("View (Profile) Site Search Category Parameters: "
      + profile.getSiteSearchCategoryParameters());
  System.out.println("View (Profile) Currency: " + profile.getCurrency());
  System.out.println("View (Profile) Timezone: " + profile.getTimezone());
  System.out.println("View (Profile) Created: " + profile.getCreated());
  System.out.println("View (Profile) Updated: " + profile.getUpdated());
  System.out.println("View (Profile) eCommerce Tracking: "
      + profile.getECommerceTracking());
  System.out.println("View (Profile) Enhanced eCommerce Tracking: "
      + profile.getEnhancedECommerceTracking());
}

PHP

Utiliza la biblioteca de cliente PHP.

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

/**
 * Example #1:
 * Requests a list of views (profiles) for the authorized user.
 */
try {
  $profiles = $analytics->management_profiles
      ->listManagementProfiles('123456', 'UA-123456-1');

} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


/**
 * Example #2:
 * Retrieves views (profiles) for all properties of the user's account,
 * using a wildcard '~all' as the webpropertyId.
 */
$profiles = $analytics->management_profiles
    ->listManagementProfiles('123456', '~all');


/**
 * Example #3:
 * The results of the list method are stored in the profiles object.
 * The following code shows how to iterate through them.
 */
foreach ($profiles->getItems() as $profile) {
  $html = <<<HTML
<pre>
Account id                      = {$profile->getAccountId()}
Property id                     = {$profile->getWebPropertyId()}
View (Profile) id               = {$profile->getId()}
View (Profile) name             = {$profile->getName()}
View (Profile) type             = {$profile->getType()}
Default page                    = {$profile->getDefaultPage()}
Exclude query parameters        = {$profile->getExcludeQueryParameters()}
Site search category parameters = {$profile->getSiteSearchCategoryParameters()}
Currency                        = {$profile->getCurrency()}
Timezone                        = {$profile->getTimezone()}
Created                         = {$profile->getCreated()}
Updated                         = {$profile->getUpdated()}
eCommerce tracking              = {$profile->getECommerceTracking()}
Enhanced eCommerce Tracking     = {$profile->getEnhancedECommerceTracking()}
</pre>
HTML;
  print $html;
}

Python

Utiliza la biblioteca de cliente Python.

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

# Example #1:
# Requests a list of views (profiles) for the authorized user.
try:
  profiles = analytics.management().profiles().list(
      accountId='12345',
      webPropertyId='UA-12345-1').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:
# Retrieves views (profiles) for all properties of the user's account,
# using a wildcard '~all' as the webpropertyId.
profiles = analytics.management().profiles().list(accountId='12345',
                                                  webPropertyId='~all'
                                                 ).execute()

# Example #3:
# The results of the list method are stored in the profiles object.
# The following code shows how to iterate through them.
for profile in profiles.get('items', []):
  print 'Account ID                = %s' % profile.get('accountId')
  print 'Property ID           = %s' % profile.get('webPropertyId')
  print 'Internal Property ID  = %s' % profile.get('internalWebPropertyId')
  print 'View (Profile ID)         = %s' % profile.get('id')
  print 'View (Profile) Name       = %s' % profile.get('name')

  print 'Default Page = %s' %  profile.get('defaultPage')
  print 'Exclude Query Parameters        = %s' % profile.get(
      'excludeQueryParameters')
  print 'Site Search Category Parameters = %s' % profile.get(
      'siteSearchCategoryParameters')
  print 'Site Search Query Parameters    = %s' % profile.get(
      'siteSearchQueryParameters')

  print 'Currency = %s' % profile.get('currency')
  print 'Timezone = %s' % profile.get('timezone')
  print 'Created  = %s' % profile.get('created')
  print 'Updated  = %s' % profile.get('updated')
  print 'eCommerce Tracking = %s' % profile.get('eCommerceTracking')
  print 'Enhanced eCommerce Tracking = %s' % profile.get(
      'enhancedECommerceTracking')

JavaScript

Utiliza la biblioteca de cliente JavaScript

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the View (Profiles) Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all View (Profiles) for the authorized user.
 */
function listViews() {
  var request = gapi.client.analytics.management.profiles.list({
    'accountId': '123456',
    'webPropertyId': 'UA-123456-1'
  });
  request.execute(printViews);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printViews(results) {
  if (results && !results.error) {
    var profiles = results.items;
    for (var i = 0, profile; profile = profiles[i]; i++) {
      console.log('Account Id: ' + profile.accountId);
      console.log('Property Id: ' + profile.webPropertyId);
      console.log('Internal Property Id: ' + profile.internalWebPropertyId);
      console.log('View (Profile) Id: ' + profile.id);
      console.log('View (Profile) Name: ' + profile.name);

      console.log('Default Page: ' + profile.defaultPage);
      console.log('Exclude Query Parameters: '
          + profile.excludeQueryParameters);
      console.log('Site Search Category Parameters'
          + profile.siteSearchCategoryParameters);
      console.log('Site Search Query Parameters: '
          + profile.siteSearchQueryParameters);

      console.log('Currency: ' + profile.currency);
      console.log('Timezone: ' + profile.timezone);
      console.log('Created: ' + profile.created);
      console.log('Updated: ' + profile.updated);
    }
  }
}

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.