Account User Links: list

Si les comptes, propriétés ou vues Google Analytics appartiennent à une entreprise, les propriétaires de cette entreprise peuvent modifier les utilisateurs de ces comptes. Toutefois, l'API de gestion ne répertorie que les membres explicites des comptes, des propriétés ou des vues, et non l'organisation ou ses propriétaires.

Autorisation requise

Répertorie les liens des utilisateurs de compte pour un compte donné. 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/entityUserLinks

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
accountId	string	ID du compte pour lequel les liens utilisateur doivent être récupérés.
Paramètres de requête facultatifs
max-results	integer	Nombre maximal de liens d'utilisateurs de compte à inclure dans cette réponse.
start-index	integer	Index du premier lien utilisateur du compte à 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.accountUserLinks 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 Account User Links for the authorized user.
 */
try {
  EntityUserLinks accountLinks = analytics.management().
      accountUserLinks().list("123456").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 accountLinks object.
 * The following code shows how to iterate through them.
 */
for (EntityUserLink accountUserLink : accountLinks.getItems()) {
  Entity entity = accountUserLink.getEntity();
  AccountRef accountRef = entity.getAccountRef();
  UserRef userRef = accountUserLink.getUserRef();
  Permissions permissions = accountUserLink.getPermissions();

  System.out.println("Account User Link Id: " + accountUserLink.getId());
  System.out.println("Account 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("Account Id: " + accountRef.getId());
  System.out.println("Account Kind: " + accountRef.getKind());
  System.out.println("Account Name: " + accountRef.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 account user links for the authorized user.
 */
try {
  $accountUserlinks = $analytics->management_accountUserLinks
      ->listManagementAccountUserLinks('123456');
} 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 accountUserlinks object.
 * The following code shows how to iterate through them.
 */
foreach ($accountUserlinks->getItems() as $accountUserLink) {
  $entity = $accountUserLink->getEntity();
  $accountRef = $entity->getAccountRef();
  $userRef = $accountUserLink->getUserRef();
  $permissions = $accountUserLink->getPermissions();

  $html = <<<HTML
<pre>
Account user link id   = {$accountUserLink->getId()}
Account user link kind = {$accountUserLink->getKind()}

Account id   = {$accountRef->getId()}
Account name = {$accountRef->getName()}
Account kind = {$accountRef->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 account-user links for the authorized user.
try:
  account_links = analytics.management().accountUserLinks().list(
      accountId='123456'
  ).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 account_links object.
# The following code shows how to iterate through them.
for accountUserLink in account_links.get('items', []):
  entity = accountUserLink.get('entity', {})
  accountRef = entity.get('accountRef', {})
  userRef = accountUserLink.get('userRef', {})
  permissions = accountUserLink.get('permissions', {})

  print 'Account User Link Id   = %s' % accountUserLink.get('id')
  print 'Account User Link kind = %s' % accountUserLink.get('kind')
  print 'User Email             = %s' % userRef.get('email')
  print 'Permissions effective  = %s' % permissions.get('effective')
  print 'Permissions local      = %s' % permissions.get('local')
  print 'Account Id             = %s' % accountRef.get('id')
  print 'Account Kind           = %s' % accountRef.get('kind')
  print 'Account Name           = %s\n' % accountRef.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 Account User links for the authorized user.
 */
function listAccountUserLinks() {
  var request = gapi.client.analytics.management.accountUserLinks.list({
      'accountId': '123456'
  });
  request.execute(printAccountUserLinks);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printAccountUserLinks(results) {
  if (results && !results.error) {
    var accountLinks = results.items;
    for (var i = 0, accountUserLink; accountUserLink = accountLinks[i]; i++) {
      var entity = accountUserLink.entity;
      var accountRef = entity.accountRef;
      var userRef = accountUserLink.userRef;
      var permissions = accountUserLink.permissions;

      console.log('Account User Link Id: ' + accountUserLink.id);
      console.log('Account User Link Kind: ' + accountUserLink.kind);
      console.log('User Email: ' + userRef.email);
      console.log('Permissions effective: ' + permissions.effective);
      console.log('Permissions local: ' + permissions.local);
      console.log('Account Id: ' + accountRef.id);
      console.log('Account Kind: ' + accountRef.kind);
      console.log('Account Name: ' + accountRef.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.