Requiere autorización
Se muestran las dimensiones personalizadas a las que el usuario tiene acceso. Pruébalo ahora y ve un ejemplo.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
accountId |
string |
Es el ID de cuenta de las dimensiones personalizadas que se recuperarán. |
webPropertyId |
string |
Es el ID de propiedad web de las dimensiones personalizadas que se recuperarán. |
Parámetros de consulta opcionales | ||
max-results |
integer |
Es la cantidad máxima de dimensiones personalizadas que se incluirán en esta respuesta. |
start-index |
integer |
Un í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 siguientes alcances (obtén más información acerca de la autenticación y 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 la solicitud con este método.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{ "kind": "analytics#customDimensions", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customDimensions Resource ] }
Nombre de la propiedad | Valor | Descripción | Notas |
---|---|---|---|
kind |
string |
Tipo de colección. | |
username |
string |
ID de correo electrónico del usuario autenticado | |
totalResults |
integer |
El número total de resultados para la consulta, sin importar el número de resultados en la respuesta. | |
startIndex |
integer |
El índice de inicio de los recursos, que es 1 de forma predeterminada o que se especifica en el parámetro de consulta del índice de inicio. | |
itemsPerPage |
integer |
La cantidad máxima de recursos que puede contener la respuesta, sin importar la cantidad real de recursos que se muestran. Su valor varía entre 1 y 1,000, con un valor de 1,000 de forma predeterminada o especificado en el parámetro de consulta max-results. | |
previousLink |
string |
Vínculo a la página anterior de esta colección de dimensiones personalizadas. | |
nextLink |
string |
Vínculo a la página siguiente de esta colección de dimensiones personalizadas. | |
items[] |
list |
Es una 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 cliente para consultar una lista de lenguajes admitidos).
Java
Usa la biblioteca cliente de 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
Usa la biblioteca cliente de 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
Usa el Explorador de APIs que aparece a continuación para llamar a este método con los datos en tiempo real y ver la respuesta. También puedes probar el Explorador independiente.