Account User Links: list

Google アナリティクスのアカウント、プロパティ、ビューが組織に属している場合、その組織のオーナーはそれらのアカウントのユーザーを編集できます。ただし、Management API はアカウント、プロパティ、ビューの明示的なメンバーのみをリストし、組織やそのオーナーはリストしません。

認証が必要です

指定されたアカウントのアカウント ユーザー リンクを一覧表示します。 今すぐ試すまたは例を見る。

標準パラメータに加えて、このメソッドはパラメータ表に示されているパラメータをサポートしています。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名	値	説明
パスパラメータ
accountId	string	ユーザーリンクを取得するアカウント ID。
省略可能なクエリ パラメータ
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.accountUserLinks 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 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

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

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

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

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。 または、スタンドアロンの Explorer をお試しください。