Metas: patch

Requer autorização

Atualiza uma meta existente. Esse método é compatível com a semântica de patch. Faça um teste agora ou veja um exemplo.

Além dos parâmetros padrão, esse método é compatível com os parâmetros listados na tabela correspondente.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
accountId string ID da conta para atualizar a meta.
goalId string Índice da meta a ser atualizada.
profileId string Código da vista (perfil) para atualizar a meta.
webPropertyId string ID da propriedade da Web para atualizar a meta.

Autorização

Essa solicitação requer uma autorização com o escopo a seguir (mais informações sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/analytics.edit

Corpo da solicitação

No corpo da solicitação, forneça as partes relevantes de um recurso "management.goal", de acordo com as regras de semântica do patch.

Resposta

Se for bem-sucedido, esse método retornará um recurso "management.goal" no corpo da resposta.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de 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

Usa a biblioteca cliente de 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

Usa a biblioteca cliente de 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

Usa a biblioteca cliente de 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. });
}

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta. Se você preferir, teste o Explorador independente.