Custom Metrics: list

認証が必要です

ユーザーがアクセスできるカスタム指標を一覧表示します。今すぐ試すまたは例を見る。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 値 説明
パスパラメータ
accountId string 取得するカスタム指標のアカウント ID。
webPropertyId string 取得するカスタム指標のウェブ プロパティ ID。
省略可能なクエリ パラメータ
max-results integer このレスポンスに含めるカスタム指標の最大数。
start-index integer 最初に取得するエンティティのインデックス。このパラメータは、max-results パラメータとともにページ設定メカニズムとして使用します。

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

範囲
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics

リクエスト本文

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

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "analytics#customMetrics",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.customMetrics Resource
  ]
}
プロパティ名 値 説明 メモ
kind string コレクション タイプ。
username string 認証されたユーザーのメール ID。
totalResults integer クエリに対する結果の合計数。レスポンス内の結果の数とは関係ありません。
startIndex integer リソースの開始インデックス。デフォルトでは 1 で、それ以外の場合は start-index クエリ パラメータに指定された数になります。
itemsPerPage integer レスポンスに含めることができるリソースの最大数。実際に返されたリソースの数とは関係ありません。値の範囲は 1 から 1,000 です。デフォルトでは 1000 で、それ以外の場合は max-results クエリ パラメータで指定された数になります。
items[] list カスタム指標のコレクション。

例

注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません（サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください）。

Java

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

/**
 * Note: This code assumes you have an authorized Analytics service object.
 */

/**
 * This request lists all custom metrics for the authorized user.
 */
try {
  CustomMetrics metrics = analytics.management.customMetrics
      .list("12345", "UA-12345-1").execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * The results of the list method are stored in the metrics object.
 * The following code shows how to iterate through them.
 */
for (CustomMetric metric : metrics.getItems()) {
  System.out.println("Metric Kind: " + metric.getKind());
  System.out.println("Metric Id: " + metric.getId());
  System.out.println("Account ID: " + metric.getAccountId());
  System.out.println("Property ID: " + metric.getWebPropertyId());
  System.out.println("Metric Name: " + metric.getName());
  System.out.println("Metric Index: " + metric.getIndex());
  System.out.println("Metric Scope: " + metric.getScope());
  System.out.println("Metric Active: " + metric.getActive());
  System.out.println("Metric Type: " + metric.getType());
  System.out.println("Metric Created: " + metric.getCreated());
  System.out.println("Metric Updated: " + metric.getUpdated());
}

Python

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

# Note: This code assumes you have an authorized Analytics service object.

# This request lists all custom metrics for the authorized user.
try:
  metrics = analytics.management().customMetrics().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))


# The results of the list method are stored in the metrics object.
# The following code shows how to iterate through them.
for metric in metrics.get('items', []):
  print 'Metric Kind = %s' % metric.get('kind')
  print 'Metric Id = %s' % metric.get('id')
  print 'Account ID = %s' % metric.get('accountId')
  print 'Property ID = %s' % metric.get('webPropertyId')
  print 'Metric Name = %s' % metric.get('name')
  print 'Metric Index = %s' % metric.get('index')
  print 'Metric Scope = %s' % metric.get('scope')
  print 'Metric Active = %s' % metric.get('active')
  print 'Metric Type = %s' % metric.get('type')
  print 'Metric Created = %s' % metric.get('created')
  print 'Metric Updated = %s' % metric.get('updated')

試してみよう:

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