Webproperty User Links: list

Requer autorização

Lista links do usuário da propriedade da Web de uma determinada propriedade da Web. 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/webproperties/webPropertyId/entityUserLinks

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de caminho
`accountId`	`string`	ID da conta à qual a propriedade da Web específica pertence.
`webPropertyId`	`string`	ID da propriedade da Web dos links webProperty-user a serem recuperados. Pode ser o ID de uma propriedade da Web específica ou "~ all", que se refere a todas as propriedades da Web a que o usuário tem acesso.
Parâmetros de consulta opcionais
`max-results`	`integer`	Número máximo de links webProperty-user a serem incluídos nessa resposta.
`start-index`	`integer`	Índice do primeiro link webProperty-user a ser recuperado. Use esse parâmetro como um mecanismo de paginação juntamente com o parâmetro "max-results".

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais 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.webpropertyUserLinks Resource
  ]
}

Nome da propriedade	Valor	Descrição
`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 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

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

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

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

Confira!

Use o APIs Explorer abaixo para chamar esse método para dados ativos e ver a resposta. Se você preferir, teste o Explorador independente.