Requiere autorización
Enumera las dimensiones personalizadas a las que el usuario tiene acceso. Pruébalo ahora o consulta un ejemplo.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions
Parámetros
Nombre de parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta | ||
accountId |
string |
ID de cuenta de las dimensiones personalizadas que se recuperarán. |
webPropertyId |
string |
ID de propiedad web de las dimensiones personalizadas que se recuperarán. |
Parámetros de consulta opcionales | ||
max-results |
integer |
Número máximo de dimensiones personalizadas 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.readonly |
https://www.googleapis.com/auth/analytics |
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#customDimensions", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customDimensions 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. | |
previousLink |
string |
Enlace a la página anterior de esta colección de dimensiones personalizadas. | |
nextLink |
string |
Enlace a la página siguiente de esta colección de dimensiones personalizadas. | |
items[] |
list |
Colección de dimensiones personalizadas. |
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. */ /** * This request lists all custom dimensions for the authorized user. */ try { CustomDimensions dimensions = analytics.management.customDimensions .list("12345", "UA-12345-1").execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /** * The results of the list method are stored in the dimensions object. * The following code shows how to iterate through them. */ for (CustomDimension dimension : dimensions.getItems()) { System.out.println("Dimension Kind: " + dimension.getKind()); System.out.println("Dimension Id: " + dimension.getId()); System.out.println("Account ID: " + dimension.getAccountId()); System.out.println("Property ID: " + dimension.getWebPropertyId()); System.out.println("Dimension Name: " + dimension.getName()); System.out.println("Dimension Index: " + dimension.getIndex()); System.out.println("Dimension Scope: " + dimension.getScope()); System.out.println("Dimension Active: " + dimension.getActive()); System.out.println("Dimension Created: " + dimension.getCreated()); System.out.println("Dimension Updated: " + dimension.getUpdated()); }
Python
Utiliza la biblioteca de cliente Python.
# Note: This code assumes you have an authorized Analytics service object. # This request lists all custom dimensions for the authorized user. try: dimensions = analytics.management().customDimensions().list( accountId='123456', webPropertyId='UA-123456-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)) # The results of the list method are stored in the dimensions object. # The following code shows how to iterate through them. for dimension in dimensions.get('items', []): print 'Dimension Kind = %s' % dimension.get('kind') print 'Dimension Id = %s' % dimension.get('id') print 'Account ID = %s' % dimension.get('accountId') print 'Property ID = %s' % dimension.get('webPropertyId') print 'Dimension Name = %s' % dimension.get('name') print 'Dimension Index = %s' % dimension.get('index') print 'Dimension Scope = %s' % dimension.get('scope') print 'Dimension Active = %s' % dimension.get('active') print 'Dimension Created = %s' % dimension.get('created') print 'Dimension Updated = %s' % dimension.get('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.