ウェブプロパティ: list

承認が必要です

ユーザーがアクセスできるプロパティを一覧表示します。こちらから今すぐお試しいただけます。または、例をご覧ください。

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

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名	値	説明
パスパラメータ
`accountId`	`string`	ウェブプロパティを取得するアカウントの ID。特定のアカウント ID か、ユーザーがアクセスできるすべてのアカウントを参照する「`~all`」。
省略可能なクエリパラメータ
`max-results`	`integer`	このレスポンスに含めるウェブプロパティの最大数。
`start-index`	`integer`	最初に取得するエンティティのインデックス。このパラメータは、`max-results` パラメータとともに改ページメカニズムとして使用します。

承認

このリクエストは、少なくとも以下のスコープの 1 つによって承認される必要があります（詳細については、認証と承認に関する記事をご覧ください）。

スコープ
`https://www.googleapis.com/auth/analytics`
`https://www.googleapis.com/auth/analytics.edit`
`https://www.googleapis.com/auth/analytics.readonly`

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

レスポンスには、リクエストされたアナリティクスのウェブプロパティごとに Webproperty リソースが 1 つ含まれます。

{
  "kind": "analytics#webproperties",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.webproperties Resource
  ]
}

プロパティ名	値	説明
`kind`	`string`	コレクションタイプ。値は「`analytics#webProperties`」です。
`username`	`string`	認証されたユーザーのメール ID。
`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 Web Property Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all properties for the authorized user.
 */
try {
  Webproperties properties = analytics.management.
      webproperties.list("12345").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

/**
 * Example #2:
 * Retrieves all properties for the user's account, using a
 * wildcard '~all' as the accountId.
 */
Webproperties properties = analytics.management.
    webproperties.list("~all").execute();

/**
 * Example #3:
 * The results of the list method are stored in the properties object.
 * The following code shows how to iterate through them.
 */
for (Webproperty property : properties.getItems()) {
  System.out.println("Account ID: " + property.getAccountId());
  System.out.println("Property ID: " + property.getId());
  System.out.println("Property Name: " + property.getName());
  System.out.println("Property Profile Count: " + property.getProfileCount());
  System.out.println("Property Industry Vertical: "
      + property.getIndustryVertical());
  System.out.println("Property Internal Id: "
      + property.getInternalWebPropertyId());
  System.out.println("Property Level: " + property.getLevel();
  if (property.getWebsiteUrl() != null) {
    System.out.println("Property URL: " + property.getWebsiteUrl());
  }
  System.out.println("Property Created: " + property.getCreated());
  System.out.println("Property Updated: " + property.getUpdated());
}

PHP

PHP クライアントライブラリを使用します。

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Web Property Developer Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all properties for the authorized user.
 */
try {
  $properties = $analytics->management_webproperties
      ->listManagementWebproperties('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:
 * Retrieves all properties for the user's account, using a
 * wildcard ~all as the accountId.
 */
$properties = $analytics->management_webproperties
    ->listManagementWebproperties('~all');

/**
 * Example #3:
 * The results of the list method are stored in the properties object.
 * The following code shows how to iterate through them.
 */
foreach ($properties->getItems() as $property) {

  $html = <<<HTML
<pre>
Account id    = {$property->getAccountId()}
Property id   = {$property->getId()}
Property name = {$property->getName()}
Property URL  = {$property->getWebsiteUrl()}
Created       = {$property->getCreated()}
Updated       = {$property->getUpdated()}
</pre>

HTML;
  print $html;
}

Python

Python クライアントライブラリを使用します。

# Note: This code assumes you have an authorized Analytics service object.
# See the Web Property Developer Guide for details.

# Example #1:
# Requests a list of all properties for the authorized user.
try:
  properties = analytics.management().webproperties().list(
      accountId='12345').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:
# Retrieves all properties for the user's account, using a
# wildcard ~all as the accountId.
properties = service.management().webproperties().list(
    accountId='~all').execute()

# Example #3:
# The results of the list method are stored in the webproperties object.
# The following code shows how to iterate through them.
for property in properties.get('items', []):
  print 'Account ID         = %s' % property.get('accountId')
  print 'Property ID    = %s' % property.get('id')
  print 'Property Name  = %s' % property.get('name')
  print 'Property Profile Count = %s' % property.get('profileCount')
  print 'Property Industry Vertical = %s' % property.get('industryVertical')
  print 'Property Internal Id = %s' % property.get(
      'internalWebPropertyId')
  print 'Property Level = %s' % property.get('level')
  if property.get('websiteUrl'):
    print 'Property URL        = %s' % property.get('websiteUrl')
  print 'Created            = %s' % property.get('created')
  print 'Updated            = %s' % property.get('updated')

JavaScript

JavaScript クライアントライブラリを使用します。

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Web Property Developer Guide for details.
 */

/*
 * Example 1:
 * Requests a list of all properties for the authorized user.
 */
function listProperties() {
  var request = gapi.client.analytics.management.webproperties.list({
    'accountId': '123456'
  });
  request.execute(printProperties);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printProperties(results) {
  if (results && !results.error) {
    var properties = results.items;
    for (var i = 0, property; property = properties[i]; i++) {
      console.log('Account Id: ' + property.accountId);
      console.log('Property Id: ' + property.id);
      console.log('Property Name: ' + property.name);
      console.log('Property Profile Count: ' + property.profileCount);
      console.log('Property Industry Vertical: ' + property.industryVertical);
      console.log('Property Internal Id: ' + property.internalWebPropertyId);
      console.log('Property Level: ' + property.level);
      if (property.websiteUrl) {
        console.log('Property URL: ' + property.websiteUrl);
      }

      console.log('Created: ' + property.created);
      console.log('Updated: ' + property.updated);
    }
  }
}

試してみる

リアルタイムのデータでこのメソッドを呼び出してレスポンスを確認するには、以下の APIs Explorer か、スタンドアロンのテストツールをご利用ください。

ウェブ プロパティ: list