Profile User Links: list

Autorisierung erforderlich

Listet Profil-Nutzer-Links für eine bestimmte Datenansicht (Profil) auf. Probieren Sie es aus oder sehen Sie sich ein Beispiel an.

Bei dieser Methode werden zusätzlich zu den Standardparametern die in der Parametertabelle aufgeführten Parameter unterstützt.

Anfragen

HTTP-Anfrage

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks

Parameter

Parametername Wert Beschreibung
Pfadparameter
accountId string Konto-ID, zu der die jeweilige Datenansicht (das Profil) gehört
profileId string ID der Datenansicht (Profil-ID), für die die Links des Profilnutzers abgerufen werden sollen Kann entweder eine bestimmte Profil-ID oder „~all“ sein, das sich auf alle Profile bezieht, auf die der Nutzer Zugriff hat.
webPropertyId string Die Web-Property-ID, zu der die jeweilige Datenansicht (das Profil) gehört. Sie kann entweder eine bestimmte Web-Property-ID oder „~all“ sein, das sich auf alle Web-Properties bezieht, auf die der Nutzer Zugriff hat.
Optionale Abfrageparameter
max-results integer Die maximale Anzahl von Profilnutzer-Links, die in diese Antwort aufgenommen werden können.
start-index integer Ein Index des ersten abzurufenden Links des Profilnutzers. Verwenden Sie diesen Parameter als Paginierungsmechanismus zusammen mit dem Parameter "max-results".

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

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

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "analytics#entityUserLinks",
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.profileUserLinks Resource
  ]
}
Name der Eigenschaft Wert Beschreibung Hinweise
kind string Sammlungstyp.
totalResults integer Die Gesamtzahl der Ergebnisse für die Abfrage, unabhängig von der Anzahl der Ergebnisse in der Antwort.
startIndex integer Der Startindex der Einträge, der standardmäßig 1 ist oder anderweitig durch den Abfrageparameter „start-index“ angegeben wird.
itemsPerPage integer Die maximale Anzahl von Einträgen, die die Antwort enthalten kann, unabhängig von der tatsächlichen Anzahl der zurückgegebenen Einträge. Der Wert reicht von 1 bis 1.000, wobei standardmäßig der Wert 1.000 festgelegt ist oder durch den Abfrageparameter „max-results“ anders angegeben wird.
items[] list Eine Liste von Nutzerlinks für Entitäten.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

Java

Verwendet die Java-Clientbibliothek.

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

Verwendet die PHP-Clientbibliothek.

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

Verwendet die Python-Clientbibliothek.

# 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

Verwendet die JavaScript-Clientbibliothek.

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

Jetzt testen

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen. Probieren Sie alternativ den eigenständigen Explorer aus.