Listet WebProperty-Nutzerlinks für eine bestimmte Web-Property auf. Jetzt ausprobieren oder Beispiel ansehen
Neben den Standardparametern unterstützt diese Methode die in der Parametertabelle aufgeführten Parameter.
Anfragen
HTTP-Anfrage
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/entityUserLinks
Parameter
Parametername | Wert | Beschreibung |
---|---|---|
Pfadparameter | ||
accountId |
string |
Die Konto-ID, zu der die angegebene Web-Property gehört |
webPropertyId |
string |
Web-Property-ID für die abzurufenden WebProperty-Nutzer-Links. Dies kann entweder eine bestimmte Web-Property-ID oder '~all' sein, die sich auf alle Web-Properties bezieht, auf die der Nutzer Zugriff hat. |
Optionale Suchparameter | ||
max-results |
integer |
Die maximale Anzahl von „webProperty-user“-Links, die in dieser Antwort enthalten sein sollen. |
start-index |
integer |
Index des ersten „webProperty-user“-Links, der abgerufen werden soll. 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.webpropertyUserLinks 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 oder vom Parameter "start-index" anderweitig angegeben ist. | |
itemsPerPage |
integer |
Die maximale Anzahl der Einträge, die die Antwort enthalten kann, unabhängig von der tatsächlichen Anzahl der zurückgegebenen Einträge. Sein Wert reicht von 1 bis 1000, wobei der Wert standardmäßig 1000 beträgt oder anderweitig durch den Abfrageparameter "max-results" angegeben wird. | |
previousLink |
string |
Vorheriger Link für diese Kontosammlung. | |
nextLink |
string |
Nächster Link für diese Kontosammlung. | |
items[] |
list |
Eine Liste der Entitätsnutzerlinks. |
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 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
Die PHP-Clientbibliothek wird verwendet.
/** * 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
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 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
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 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); } } }
Testen!
Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen. Alternativ können Sie den eigenständigen Explorer ausprobieren.