Requiere autorización
Enumera las fuentes de datos personalizadas a las que el usuario tiene acceso. Pruébalo ahora y ve un ejemplo.
Además de los parámetros estándar, este método admite los parámetros enumerados en la tabla de parámetros.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
accountId |
string |
Es el ID de cuenta de las fuentes de datos personalizadas que se recuperarán. |
webPropertyId |
string |
Es el ID de propiedad web de las fuentes de datos personalizadas que se recuperarán. |
Parámetros de consulta opcionales | ||
max-results |
integer |
La cantidad máxima de fuentes de datos personalizadas que se incluirán en esta respuesta. |
start-index |
integer |
Es un índice basado en 1 de la primera fuente de datos personalizada 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 |
https://www.googleapis.com/auth/analytics.edit |
https://www.googleapis.com/auth/analytics.readonly |
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#customDataSources", "username": string, "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.customDataSources 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 fuente de datos personalizada. | |
nextLink |
string |
Vínculo a la página siguiente de esta colección de fuente de datos personalizada. | |
items[] |
list |
Es la colección de fuentes de datos 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. * See the Data Import Developer Guide for details. */ /* * Example #1: * Requests a list of all customDataSources for the authorized user. */ try { CustomDataSources sources = analytics.management(). customDataSources().list("123456", "UA-123456-1").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 sources object. * The following code shows how to iterate through them. */ for (CustomDataSource source : sources.getItems()) { System.out.println("Account Id = " + source.getAccountId()); System.out.println("Property Id = " + source.getWebPropertyId()); System.out.println("Custom Data Source Id = " + source.getId()); System.out.println("Custom Data Source Kind = " + source.getKind()); System.out.println("Custom Data Source Type = " + source.getType()); System.out.println("Custom Data Source Name = " + source.getName()); System.out.println("Custom Data Source Description = " + source.getDescription()); System.out.println("Custom Data Source Upload Type = " + source.getUploadType()); System.out.println("\n"); }
PHP
Utiliza la biblioteca cliente PHP.
/** * Note: this code assumes you have an authorized Analytics service object. * See the Data Import Developer Guide for details. */ /** * Example #1: * Requests a list of all data sets for the authorized user. */ try { $dataSets = $analytics->management_customDataSources ->listManagementCustomDataSources('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: * The results of the list method are stored in the dataSets object. * The following code shows how to iterate through them. */ foreach ($dataSets->getItems() as $dataSet) { $html = <<<HTML <pre> Account id = {$dataSet->getAccountId()} Property id = {$dataSet->getWebPropertyId()} Data set id = {$dataSet->getId()} Data set kind = {$dataSet->getKind()} Data set type = {$dataSet->getType()} Data set name = {$dataSet->getName()} Data set description = {$dataSet->getDescription()} Data set upload type = {$dataSet->getUploadType()} </pre> HTML; print $html; }
Python
Usa la biblioteca cliente de Python.
# Note: This code assumes you have an authorized Analytics service object. # See the Custom Data Source Developer Guide for details. # Example #1: # Requests a list of all customDataSources for the authorized user. try: custom_data_sources = analytics.management().customDataSources().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)) # Example #2: # The results of the list method are stored in the custom_data_sources object. # The following code shows how to iterate through them. for custom_data_source in custom_data_sources.get('items', []): print 'Account ID = %s' % custom_data_source.get('accountId') print 'Property ID = %s' % custom_data_source.get('webPropertyId') print 'Custom Data Source ID = %s' % custom_data_source.get('id') print 'Custom Data Source Kind = %s' % custom_data_source.get('kind') print 'Custom Data Source Type = %s' % custom_data_source.get('type') print 'Custom Data Source Name = %s' % custom_data_source.get('name') print 'Custom Data Source Description = %s' % custom_data_source.get('description') print 'Custom Data Source uploadType = %s' % custom_data_source.get('uploadType') print 'Linked Views (Profiles):' for profile in custom_data_source.get('profilesLinked', []): print ' View (Profile) ID = %s' % profile print 'Created = %s' % custom_data_source.get('created') print 'Updated = %s\n' % custom_data_source.get('updated')
JavaScript
Usa la biblioteca cliente de JavaScript.
/* * Note: This code assumes you have an authorized Analytics client object. * See the Data Import Developer Guide for details. */ /* * Example 1: * Requests a list of all data sets for the authorized user. */ function listCustomDataSources() { var request = gapi.client.analytics.management.customDataSources.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1' }); request.execute(printCustomDataSources); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printCustomDataSources(results) { if (results && !results.error) { var datasets = results.items; for (var i = 0, dataset; dataset = datasets[i]; i++) { console.log('Account Id: ' + dataset.accountId); console.log('Property Id: ' + dataset.webPropertyId); console.log('Dataset Id: ' + dataset.id); console.log('Dataset Kind: ' + dataset.kind); console.log('Dataset Name: ' + dataset.name); console.log('Dataset Description: ' + dataset.description); console.log('Dataset uploadType: ' + dataset.uploadType); // Iterate through the linked views (profiles). var profiles = dataset.profilesLinked; if (profiles) { for (var j = 0, profile; profile = profiles[j]; j++) { console.log('Linked view (profile) Id: ' + profile); } } } } }
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.