Цели: метод patch

Требуется авторизация

Обновляет существующую цель. Этот метод поддерживает семантику PATCH. Испытайте его в действии или изучите готовый пример.

Помимо стандартных параметров, этот метод поддерживает параметры, перечисленные в таблице ниже.

Запрос

HTTP-запрос

PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId

Параметры

Название параметра Значение Описание
Параметры пути
accountId string Идентификатор аккаунта, для которого требуется обновить цель.
goalId string Индекс обновляемой цели.
profileId string Идентификатор представления (профиля), для которого требуется обновить цель.
webPropertyId string Идентификатор веб-ресурса, для которого требуется обновить цель.

Авторизация

Этот запрос требует авторизации в указанной ниже области доступа. Подробнее об аутентификации и авторизации

Область доступа
https://www.googleapis.com/auth/analytics.edit

Тело запроса

В теле запроса требуется предоставить части ресурса management.goal в соответствии с правилами семантики PATCH.

Ответ

В случае успеха метод возвращает ресурс 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. });
}

Практическое занятие

Воспользуйтесь инструментом API Explorer ниже, чтобы применить этот метод к реальным данным и посмотреть, как он работает. Также доступен автономный вариант инструмента.