Web Properties: list

Requires authorization

Lists properties to which the user has access. 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

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

Parameters

Parameter name Value Description
Path parameters
accountId string Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.
Optional query parameters
max-results integer The maximum number of web properties to include in this response.
start-index integer An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

The response contains one Webproperty resource for each Analytics web property requested.

{
  "kind": "analytics#webproperties",
  "username": string,
  "totalResults": integer,
  "startIndex": integer,
  "itemsPerPage": integer,
  "previousLink": string,
  "nextLink": string,
  "items": [
    management.webproperties Resource
  ]
}
Property name Value Description Notes
kind string Collection type. Value is "analytics#webProperties".
username string Email ID of the authenticated user
totalResults integer The total number of results for the query, regardless of the number of results in the response.
startIndex integer The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
itemsPerPage integer The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
items[] list A list of web properties.

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.
 */

/**
 * Example #1:
 * Requests a list of all properties for the authorized user.
 */
try {
  Webproperties properties = analytics.management.
      webproperties.list("12345").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/**
 * Example #2:
 * Retrieves all properties for the user's account, using a
 * wildcard '~all' as the accountId.
 */
Webproperties properties = analytics.management.
    webproperties.list("~all").execute();


/**
 * Example #3:
 * The results of the list method are stored in the properties object.
 * The following code shows how to iterate through them.
 */
for (Webproperty property : properties.getItems()) {
  System.out.println("Account ID: " + property.getAccountId());
  System.out.println("Property ID: " + property.getId());
  System.out.println("Property Name: " + property.getName());
  System.out.println("Property Profile Count: " + property.getProfileCount());
  System.out.println("Property Industry Vertical: "
      + property.getIndustryVertical());
  System.out.println("Property Internal Id: "
      + property.getInternalWebPropertyId());
  System.out.println("Property Level: " + property.getLevel();
  if (property.getWebsiteUrl() != null) {
    System.out.println("Property URL: " + property.getWebsiteUrl());
  }
  System.out.println("Property Created: " + property.getCreated());
  System.out.println("Property Updated: " + property.getUpdated());
}

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.
 */

/**
 * Example #1:
 * Requests a list of all properties for the authorized user.
 */
try {
  $properties = $analytics->management_webproperties
      ->listManagementWebproperties('123456');

} 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();
}


/**
 * Example #2:
 * Retrieves all properties for the user's account, using a
 * wildcard ~all as the accountId.
 */
$properties = $analytics->management_webproperties
    ->listManagementWebproperties('~all');


/**
 * Example #3:
 * The results of the list method are stored in the properties object.
 * The following code shows how to iterate through them.
 */
foreach ($properties->getItems() as $property) {

  $html = <<<HTML
<pre>
Account id    = {$property->getAccountId()}
Property id   = {$property->getId()}
Property name = {$property->getName()}
Property URL  = {$property->getWebsiteUrl()}
Created       = {$property->getCreated()}
Updated       = {$property->getUpdated()}
</pre>

HTML;
  print $html;
}

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.


# Example #1:
# Requests a list of all properties for the authorized user.
try:
  properties = analytics.management().webproperties().list(
      accountId='12345').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))


# Example #2:
# Retrieves all properties for the user's account, using a
# wildcard ~all as the accountId.
properties = service.management().webproperties().list(
    accountId='~all').execute()


# Example #3:
# The results of the list method are stored in the webproperties object.
# The following code shows how to iterate through them.
for property in properties.get('items', []):
  print 'Account ID         = %s' % property.get('accountId')
  print 'Property ID    = %s' % property.get('id')
  print 'Property Name  = %s' % property.get('name')
  print 'Property Profile Count = %s' % property.get('profileCount')
  print 'Property Industry Vertical = %s' % property.get('industryVertical')
  print 'Property Internal Id = %s' % property.get(
      'internalWebPropertyId')
  print 'Property Level = %s' % property.get('level')
  if property.get('websiteUrl'):
    print 'Property URL        = %s' % property.get('websiteUrl')
  print 'Created            = %s' % property.get('created')
  print 'Updated            = %s' % property.get('updated')

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.
 */

/*
 * Example 1:
 * Requests a list of all properties for the authorized user.
 */
function listProperties() {
  var request = gapi.client.analytics.management.webproperties.list({
    'accountId': '123456'
  });
  request.execute(printProperties);
}

/*
 * Example 2:
 * The results of the list method are passed as the results object.
 * The following code shows how to iterate through them.
 */
function printProperties(results) {
  if (results && !results.error) {
    var properties = results.items;
    for (var i = 0, property; property = properties[i]; i++) {
      console.log('Account Id: ' + property.accountId);
      console.log('Property Id: ' + property.id);
      console.log('Property Name: ' + property.name);
      console.log('Property Profile Count: ' + property.profileCount);
      console.log('Property Industry Vertical: ' + property.industryVertical);
      console.log('Property Internal Id: ' + property.internalWebPropertyId);
      console.log('Property Level: ' + property.level);
      if (property.websiteUrl) {
        console.log('Property URL: ' + property.websiteUrl);
      }

      console.log('Created: ' + property.created);
      console.log('Updated: ' + property.updated);
    }
  }
}

Try it!

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