カスタム ディメンション: patch

承認が必要です

既存のカスタム ディメンションを更新します。このメソッドはパッチの動作をサポートしています。 こちらから今すぐお試しいただけます。または、をご覧ください。

リクエスト

HTTP リクエスト

PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId

パラメータ

パラメータ名 説明
パスパラメータ
accountId string 更新するカスタム ディメンションのアカウント ID。
customDimensionId string 更新するカスタム ディメンションのカスタム ディメンション ID。
webPropertyId string 更新するカスタム ディメンションのウェブ プロパティ ID。
省略可能なクエリ パラメータ

承認

このリクエストには、次のスコープの承認が必要です(詳細については、認証と承認に関する記事をご覧ください)。

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

リクエスト本文

パッチの動作規則に従って、management.customDimension リソースの関連する部分をリクエスト本文に含めます。

レスポンス

成功すると、このメソッドによって、management.customDimension リソースを含むレスポンス本文が返されます。

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

Java

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

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

/*
 * This request patches an existing custom dimension.
 */

// Construct the body of the request and set its properties.
CustomDimension body = new CustomDimension();
body.setName("Campaign Group");
body.setScope("SESSION");
body.setActive(true);

try {
  analytics.management().customDimensions()
      .patch("123456", "UA-123456-1", "ga:dimension2", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

Python

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

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

# This request patches an existing custom dimension.
try:
  analytics.management().customDimensions().patch(
      accountId='123456',
      webPropertyId='UA-123456-1',
      customDimensionId='ga:dimension2',
      body={
          'name': 'Campaign Group',
          'scope': 'SESSION',
          'active': True
      }
  ).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))

試してみる

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