Web Properties: patch

Requires authorization

Updates an existing property. This method supports patch semantics. Try it now or see an example.

In addition to the standard parameters, this method supports the parameters listed in the parameters table.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string Account ID to which the web property belongs
webPropertyId string Web property ID

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

In the request body, supply the relevant portions of a management.webproperty resource, according to the rules of patch semantics.

Response

If successful, this method returns a management.webproperty resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Web Property Developer Guide for details.
 */

/*
 * This request patches an existing property.
 */

// Construct the body of the request.
Webproperty body = new Webproperty();
body.setName("Example Pet Store");
body.setWebsiteUrl("http://www.examplepetstore.com");

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

PHP

Uses the PHP client library.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Web Property Developer Guide for details.
 */

/**
 * This request patches an existing property.
 */

// Construct the body of the request.
$property = new Google_Service_Analytics_Webproperty();
$property->setName('Example Store');
$property->setIndustryVertical('MARKETING');

try {
  $analytics->management_webproperties->patch('123456', 'UA-123456-1',
      $property);
} 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

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.
# See the Web Property Developer Guide for details.

# This request patches an existing property.
try:
  analytics.management().webproperties().patch(
      accountId='123456',
      webPropertyId='UA-123456-1',
      body={
          'websiteUrl': 'http://www.examplepetstore.com',
          'name': 'Example Store'
      }
  ).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

Uses the JavaScript client library.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Web Property Developer Guide for details.
 */

/*
 * This request patches an existing property.
 */
function patchProperty() {
  var request = gapi.client.analytics.management.webproperties.patch(
    {
      'accountId': '123456',
      'webPropertyId': 'UA-123456-1',
      'resource': {
        'websiteUrl': 'http://www.examplepetstore.com',
        'name': 'Example Store'
      }
    });
  request.execute(function (response) { // Handle the response. });
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.