Goals: patch

需要授權

更新現有目標。這個方法支援修補程式語意。立即試用或參閱範例。

除了標準參數以外，這個方法也支援參數表格中列出的參數。

要求

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，針對有效資料呼叫這個方法，然後查看回應。或者，您也可以試試獨立的 Explorer。