Requiere autorización
Enumera los vínculos de perfil-usuario de una vista determinada (perfil). 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/profiles/profileId/entityUserLinks
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
accountId |
string |
ID de la cuenta a la que pertenece la vista determinada (perfil). |
profileId |
string |
ID de View (perfil) para el que se recuperarán los vínculos de usuario 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 |
Es el ID de propiedad web al que pertenece la vista determinada (perfil). Puede ser un ID de propiedad web específico o "~all", que hace referencia a todas las propiedades web a las que el usuario tiene acceso. |
Parámetros de consulta opcionales | ||
max-results |
integer |
La cantidad máxima de vínculos de usuario de perfil que se deben incluir en esta respuesta. |
start-index |
integer |
Un índice del primer vínculo de usuario del perfil 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.manage.users |
https://www.googleapis.com/auth/analytics.manage.users.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#entityUserLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.profileUserLinks Resource ] }
Nombre de la propiedad | Valor | Descripción | Notas |
---|---|---|---|
kind |
string |
Tipo de colección. | |
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 las entradas, que es 1 de forma predeterminada o que el parámetro de consulta del índice de inicio lo especifica. | |
itemsPerPage |
integer |
La cantidad máxima de entradas que puede contener la respuesta, sin importar la cantidad real de entradas 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 anterior de esta colección de cuentas. | |
nextLink |
string |
Siguiente vínculo de esta colección de cuentas. | |
items[] |
list |
Una lista de vínculos de usuarios de entidades. |
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 User Permissions Developer Guide for details. */ /* * Example #1: * This request lists all View (Profile) User Links for the authorized user. */ try { EntityUserLinks profileLinks = analytics.management(). profileUserLinks().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 profileLinks object. * The following code shows how to iterate through them. */ for (EntityUserLink profileUserLink : profileLinks.getItems()) { Entity entity = profileUserLink.getEntity(); ProfileRef profileRef = entity.getProfileRef(); UserRef userRef = profileUserLink.getUserRef(); Permissions permissions = profileUserLink.getPermissions(); System.out.println("Profile User Link Id: " + profileUserLink.getId()); System.out.println("Profile User Link kind: " + userRef.getKind()); System.out.println("User Email: " + userRef.getEmail()); System.out.println("Permissions effective: " + permissions.getEffective()); System.out.println("Permissions local: " + permissions.getLocal()); System.out.println("Profile Id: " + profileRef.getId()); System.out.println("Profile Kind: " + profileRef.getKind()); System.out.println("Profile Name: " + profileRef.getName()); }
PHP
Utiliza la biblioteca cliente PHP.
/** * Note: This code assumes you have an authorized Analytics service object. * See the User Permissions Developer Guide for details. */ /** * Example #1: * Requests a list of all view (profile) user links for the authorized user. */ try { $profileUserlinks = $analytics->management_profileUserLinks ->listManagementProfileUserLinks('123456', 'UA-123456-1', '756321'); } 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 profileUserlinks object. * The following code shows how to iterate through them. */ foreach ($profileUserlinks->getItems() as $profileUserLink) { $entity = $profileUserLink->getEntity(); $profileRef = $entity->getProfileRef(); $userRef = $profileUserLink->getUserRef(); $permissions = $profileUserLink->getPermissions(); $html = <<<HTML <pre> Profile user link id = {$profileUserLink->getId()} Profile user link kind = {$profileUserLink->getKind()} Profile id = {$profileRef->getId()} Profile name = {$profileRef->getName()} Profile kind = {$profileRef->getKind()} Permissions local = {$permissions->getLocal()} Permissions effective = {$permissions->getEffective()} User id = {$userRef->getId()} User kind = {$userRef->getKind()} User email = {$userRef->getEmail()} </pre> HTML; print $html; }
Python
Usa la biblioteca cliente de Python.
# Note: This code assumes you have an authorized Analytics service object. # See the User Permissions Developer Guide for details. # Example #1: # Requests a list of profile-user links for a given view (profile). try: profile_links = analytics.management().profileUserLinks().list( accountId='123456', webPropertyId='UA-123456-1', profileId='12345678' ).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 profile_links object. # The following code shows how to iterate through them. for profileUserLink in profile_links.get('items', []): entity = profileUserLink.get('entity', {}) profileRef = entity.get('profileRef', {}) userRef = profileUserLink.get('userRef', {}) permissions = profileUserLink.get('permissions', {}) print 'Profile User Link Id = %s' % profileUserLink.get('id') print 'Profile User Link kind = %s' % profileUserLink.get('kind') print 'User Email = %s' % userRef.get('email') print 'Permissions effective = %s' % permissions.get('effective') print 'Permissions local = %s' % permissions.get('local') print 'Profile Id = %s' % profileRef.get('id') print 'Profile kind = %s' % profileRef.get('kind') print 'Profile Name = %s\n' % profileRef.get('name')
JavaScript
Usa la biblioteca cliente de JavaScript.
/* * Note: This code assumes you have an authorized Analytics client object. * See the User Permissions Developer Guide for details. */ /* * Example 1: * Requests a list of all View (Profile) User links for the authorized user. */ function listProfileUserLinks() { var request = gapi.client.analytics.management.profileUserLinks.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1', 'profileId': '7654321' }); request.execute(printProfileUserLinks); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printProfileUserLinks(results) { if (results && !results.error) { var profileLinks = results.items; for (var i = 0, profileUserLink; profileUserLink = profileLinks[i]; i++) { var entity = profileUserLink.entity; var profileRef = entity.profileRef; var userRef = profileUserLink.userRef; var permissions = profileUserLink.permissions; console.log('Profile User Link Id: ' + profileUserLink.id); console.log('Profile User Link Kind: ' + profileUserLink.kind); console.log('User Email: ' + userRef.email); console.log('Permissions effective: ' + permissions.effective); console.log('Permissions local: ' + permissions.local); console.log('Profile Id: ' + profileRef.id); console.log('Profile Kind: ' + profileRef.kind); console.log('Profile Name: ' + profileRef.name); } } }
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.