Links do usuário da conta: list

Se as contas, propriedades ou vistas do Google Analytics pertencem a uma organização, os proprietários dessa organização precisam ter a capacidade de editar os usuários nas contas em questão. No entanto, as listas de gerenciamento da API exibem somente os membros das contas, propriedades ou vistas, não a organização ou os proprietários dela.

Requer autorização

Lista links de usuários de uma determinada conta. Faça um teste agora ou veja um exemplo.

Além dos parâmetros padrão, esse método é compatível com os parâmetros listados na tabela correspondente.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/entityUserLinks

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de caminho
accountId	string	ID da conta da qual recuperar os links do usuário.
Parâmetros de consulta opcionais
max-results	integer	Número máximo de links de usuários da conta a serem incluídos nessa resposta.
start-index	integer	Índice do primeiro link de usuário da conta a ser recuperado. Use esse parâmetro como um mecanismo de paginação juntamente com o parâmetro "max-results".

Autorização

Essa solicitação requer autorização com pelo menos um dos escopos a seguir (mais informações sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/analytics.manage.users
https://www.googleapis.com/auth/analytics.manage.users.readonly

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "analytics#entityUserLinks",
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.accountUserLinks Resource
  ]
}

Nome da propriedade	Valor	Descrição	Observações
kind	string	Tipo de conjunto.
totalResults	integer	Número total de resultados da consulta, independentemente do número de resultados na resposta.
startIndex	integer	O índice inicial das entradas, que é 1 por padrão ou outro especificado pelo parâmetro de consulta "start-index".
itemsPerPage	integer	Número máximo de entradas que a resposta pode conter, independentemente do número real de entradas retornadas. O valor varia de 1 a 1.000, sendo que o valor padrão é 1.000 ou outro valor especificado pelo parâmetro de consulta "max-results".
previousLink	string	Link anterior para este conjunto da conta.
nextLink	string	Próximo link para este conjunto da conta.
items[]	list	Uma lista de links do usuário da entidade.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a 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 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

Usa a biblioteca cliente de 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

Usa a 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 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

Usa a 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 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);
    }
  }
}

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta. Como alternativa, teste o Explorador independente.