承認が必要です
既存の目標を更新します。このメソッドはパッチの動作をサポートしています。 こちらから今すぐお試しいただけます。または、例をご覧ください。
標準パラメータに加えて、このメソッドはパラメータ表に示されているパラメータをサポートしています。
リクエスト
HTTP リクエスト
PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
accountId |
string |
目標を更新するアカウント ID。 |
goalId |
string |
更新する目標のインデックス。 |
profileId |
string |
目標を更新するビュー(旧プロファイル)の ID。 |
webPropertyId |
string |
目標を更新するウェブ プロパティ ID。 |
承認
このリクエストは、次のスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
スコープ |
---|
https://www.googleapis.com/auth/analytics.edit |
リクエスト本文
パッチの動作規則に従って、management.goal リソースの関連する部分をリクエスト本文に含めます。
レスポンス
成功すると、このメソッドによって management.goal リソースを含むレスポンスの本文が返されます。
例
注: このメソッドで使用可能なコード例では、サポートされているプログラミング言語すべての例を示しているわけではありません(サポートされている言語の一覧については、クライアント ライブラリ ページをご覧ください)。
Java
Java クライアント ライブラリを使用します。
/* * Note: This code assumes you have an authorized Analytics service object. * See the Goals Developer Guide for details. */ /* * This request patches an existing Goal. */ // Construct the body of the request. Goal body = new Goal(); body.setActive(false); body.setName("My Goal"); body.setType("VISIT_TIME_ON_SITE"); // Construct the time on site details. VisitTimeOnSiteDetails details = new VisitTimeOnSiteDetails(); details.setComparisonType("GREATER_THAN"); details.setComparisonValue((long) 500.0); // Set the time on site details. body.setVisitTimeOnSiteDetails(details); try { analytics.management().goals().patch("123456", "UA-123456-1", "7654321", "1", body).execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); }
PHP
PHP クライアント ライブラリを使用します。
/** * Note: This code assumes you have an authorized Analytics service object. * See the Goal Developer Guide for details. */ /** * This request patches an existing Goal. */ // Construct the time on site details. $details = new Google_Service_Analytics_GoalVisitTimeOnSiteDetails(); $details->setComparisonType('GREATER_THAN'); $details->setComparisonValue(300.0); try { // Get an existing goal. $goal = $analytics->management_goals->get('123456', 'UA-123456-1', '756321', '2'); $goal->setVisitTimeOnSiteDetails($details); // Call the patch function. $analytics->management_goals->patch('123456', 'UA-123456-1', '756321', '5', $goal); } 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(); }
Python
Python クライアント ライブラリを使用します。
# Note: This code assumes you have an authorized Analytics service object. # See the Goal Developer Guide for details. # This request patches an existing goal. try: analytics.management().goals().patch( accountId='123456', webPropertyId='UA-123456-1', profileId='7654321', goalId='2', body={ 'active': False, 'name': 'My Goal', 'type': 'VISIT_TIME_ON_SITE', 'visitTimeOnSiteDetails': { 'comparisonType': 'GREATER_THAN', 'comparisonValue': 600 } } ).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))
JavaScript
JavaScript クライアント ライブラリを使用します。
/* * Note: This code assumes you have an authorized Analytics client object. * See the Goals Developer Guide for details. */ /* * This request patches an existing goal. */ function patchGoal() { var request = gapi.client.analytics.management.goals.patch( { 'accountId': '123456', 'webPropertyId': 'UA-123456-1', 'profileId': '7654321', 'goalId': '5', 'resource': { 'id': '2', 'active': true, 'name': 'My Goal', 'type': 'VISIT_TIME_ON_SITE', 'visitTimeOnSiteDetails': { 'comparissonType': 'GREATER_THAN', 'comparisonValue': 300 } } }); request.execute(function (response) { // Handle the response. }); }
試してみる
リアルタイムのデータでこのメソッドを呼び出してレスポンスを確認するには、以下の APIs Explorer か、スタンドアロンのテストツールをご利用ください。