承認が必要です
指定されたビュー(旧プロファイル)のプロファイル ユーザー リンクを一覧表示します。 こちらから今すぐお試しいただけます。または、例をご覧ください。
標準パラメータに加えて、このメソッドはパラメータ表に示されているパラメータをサポートしています。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
accountId |
string |
指定したビューが属するアカウントの ID。 |
profileId |
string |
プロファイル ユーザー リンクを取得するビューの ID。特定のプロファイル ID か、ユーザーがアクセスできるすべてのプロファイルを参照する「~all」。 |
webPropertyId |
string |
指定したビューが属するウェブ プロパティの ID。特定のウェブ プロパティ ID か、ユーザーがアクセスできるすべてのウェブ プロパティを参照する「~all」。 |
省略可能なクエリ パラメータ | ||
max-results |
integer |
このレスポンスに含めるプロファイル ユーザーリンクの最大数。 |
start-index |
integer |
最初に取得するプロファイル·ユーザー·リンクのインデックス。このパラメータは、max-results パラメータと共に改ページ メカニズムとして使用します。 |
承認
このリクエストは、少なくとも以下のスコープの 1 つによって承認される必要があります(詳細については、認証と承認に関する記事をご覧ください)。
スコープ |
---|
https://www.googleapis.com/auth/analytics.manage.users |
https://www.googleapis.com/auth/analytics.manage.users.readonly |
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "kind": "analytics#entityUserLinks", "totalResults": integer, "startIndex": integer, "itemsPerPage": integer, "previousLink": string, "nextLink": string, "items": [ management.profileUserLinks Resource ] }
プロパティ名 | 値 | 説明 | 備考 |
---|---|---|---|
kind |
string |
コレクション タイプ。 | |
totalResults |
integer |
クエリに対する結果の合計数。レスポンス内の結果の数とは関係ありません。 | |
startIndex |
integer |
エントリの開始インデックス。デフォルトでは 1 で、それ以外の場合は start-index クエリ パラメータに指定された数になります。 | |
itemsPerPage |
integer |
レスポンスに含めることができるエントリの最大数。実際に返されたエントリの数とは関係ありません。値の範囲は 1 から 1,000 です。デフォルトでは 1,000 で、それ以外の場合は max-results クエリ パラメータで指定された数になります。 | |
previousLink |
string |
このアカウント コレクションの前のリンク。 | |
nextLink |
string |
このアカウント コレクションの次のリンク。 | |
items[] |
list |
エンティティ ユーザー リンクのリスト。 |
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
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 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
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 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
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 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
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 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); } } }
試してみる
リアルタイムのデータでこのメソッドを呼び出してレスポンスを確認するには、以下の APIs Explorer か、 スタンドアロンの テストツール をご利用ください。