Autorisation requise
Répertorie les liens webProperty-user pour une propriété Web donnée. Essayez maintenant ou consultez un exemple.
Outre les paramètres standards, cette méthode accepte les paramètres répertoriés dans le tableau des paramètres.
Requête
Requête HTTP
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityUserLinks
Paramètres
Nom du paramètre | Valeur | Description |
---|---|---|
Paramètres de chemin d'accès | ||
accountId |
string |
ID du compte auquel appartient la propriété Web donnée. |
webPropertyId |
string |
ID de propriété Web des liens webProperty-user à récupérer. Il peut s'agir d'un ID de site Web spécifique ou "~all" pour tous les sites Web auxquels l'utilisateur a accès. |
Paramètres de requête facultatifs | ||
max-results |
integer |
Nombre maximal de liens webProperty-user à inclure dans cette réponse. |
start-index |
integer |
Index du premier lien webProperty-user à récupérer Utilisez ce paramètre comme mécanisme de pagination avec le paramètre "max-results". |
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
Champ d'application |
---|
https://www.googleapis.com/auth/analytics.manage.users |
https://www.googleapis.com/auth/analytics.manage.users.readonly |
Corps de la requête
Ne spécifiez pas de corps de requête pour cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{ "kind": "analytics#entityUserLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.webpropertyUserLinks Resource ] }
Nom de propriété | Valeur | Description | Notes |
---|---|---|---|
kind |
string |
Type de collection. | |
totalResults |
integer |
Nombre total de résultats de la requête, quel que soit le nombre de résultats dans la réponse. | |
startIndex |
integer |
Index de départ des entrées, égal à 1 par défaut ou spécifié par le paramètre de requête "start-index". | |
itemsPerPage |
integer |
Nombre maximal d'entrées que la réponse peut contenir, quel que soit le nombre réel d'entrées renvoyées. Sa valeur est comprise entre 1 et 1 000, avec une valeur de 1 000 par défaut. Sinon, elle est spécifiée par le paramètre de requête "max-results". | |
previousLink |
string |
Lien précédent pour cette collection de comptes. | |
nextLink |
string |
Lien suivant pour cette collection de comptes. | |
items[] |
list |
Liste des liens utilisateur des entités. |
Exemples
Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).
Java
Utilise la bibliothèque cliente 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 Property User Links for the authorized user. */ try { EntityUserLinks propertyLinks = analytics.management(). webPropertyUserLinks().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 propertyLinks object. * The following code shows how to iterate through them. */ for (EntityUserLink propertyUserLink : propertyLinks.getItems()) { Entity entity = propertyUserLink.getEntity(); WebPropertyRef webPropertyRef = entity.getWebPropertyRef(); UserRef userRef = propertyUserLink.getUserRef(); Permissions permissions = propertyUserLink.getPermissions(); System.out.println("Property User Link Id: " + propertyUserLink.getId()); System.out.println("Property 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("Property Id: " + webPropertyRef.getId()); System.out.println("Property Kind: " + webPropertyRef.getKind()); System.out.println("Property Name: " + webPropertyRef.getName()); }
PHP
Utilise la bibliothèque 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 property user links for the authorized user. */ try { $propertyUserlinks = $analytics->management_webpropertyUserLinks ->listManagementwebpropertyUserLinks('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 propertyUserlinks object. * The following code shows how to iterate through them. */ foreach ($propertyUserlinks->getItems() as $propertyUserLink) { $entity = $propertyUserLink->getEntity(); $propertyeRef = $entity->getWebPropertyRef(); $userRef = $propertyUserLink->getUserRef(); $permissions = $propertyUserLink->getPermissions(); $html = <<<HTML <pre> Property user link id = {$propertyUserLink->getId()} Property user link kind = {$propertyUserLink->getKind()} Property id = {$propertyeRef->getId()} Property name = {$propertyeRef->getName()} Property kind = {$propertyeRef->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
Utilise la bibliothèque cliente 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 all property user links for the authorized user. try: property_links = analytics.management().webpropertyUserLinks().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 property_links object. # The following code shows how to iterate through them. for propertyUserLink in property_links.get('items', []): entity = propertyUserLink.get('entity', {}) propertyRef = entity.get('webPropertyRef', {}) userRef = propertyUserLink.get('userRef', {}) permissions = propertyUserLink.get('permissions', {}) print 'Property User Link Id = %s' % propertyUserLink.get('id') print 'Property User Link Kind = %s' % propertyUserLink.get('kind') print 'User Email = %s' % userRef.get('email') print 'Permissions effective = %s' % permissions.get('effective') print 'Permissions local = %s' % permissions.get('local') print 'Property Id = %s' % propertyRef.get('id') print 'Property kind = %s' % propertyRef.get('kind') print 'Property Name = %s\n' % propertyRef.get('name')
JavaScript
Utilise la bibliothèque cliente 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 Property User links for the authorized user. */ function listProfileUserLinks() { var request = gapi.client.analytics.management.webpropertyUserLinks.list({ 'accountId': '123456', 'webPropertyId': 'UA-123456-1' }); request.execute(printPropertyUserLinks); } /* * Example 2: * The results of the list method are passed as the results object. * The following code shows how to iterate through them. */ function printPropertyUserLinks(results) { if (results && !results.error) { var propertyLinks = results.items; for (var i = 0, userLink; userLink = propertyLinks[i]; i++) { var entity = userLink.entity; var propertyRef = entity.webPropertyRef; var userRef = userLink.userRef; var permissions = userLink.permissions; console.log('Property User Link Id: ' + userLink.id); console.log('Property User Link Kind: ' + userLink.kind); console.log('User Email: ' + userRef.email); console.log('Permissions effective: ' + permissions.effective); console.log('Permissions local: ' + permissions.local); console.log('Property Id: ' + propertyRef.id); console.log('Property Kind: ' + propertyRef.kind); console.log('Property Name: ' + propertyRef.name); } } }
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse. Vous pouvez également utiliser la version autonome de l'explorateur.