Google Analytics

Web Properties: list

Requires authorization

Lists web 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
Required 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 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 built an authorized Analytics service object.
 * See the Web Property Dev Guide for details.
 */

/**
 * Example #1:
 * Requests a list of all web properties for accountId 12345.
 */
try {
  Webproperties webproperties = 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 web properties for the user's account, using a
 * wildcard ~all as the accountId.
 */
Webproperties webproperties = analytics.management.webproperties.list("~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 (Webproperty webproperty : webproperties.getItems()) {
  System.out.println("Account ID: " + webproperty.getAccountId());
  System.out.println("Web Property ID: " + webproperty.getId());
  System.out.println("Web Property Name: " + webproperty.getName());
  System.out.println("Web Property Internal Id: " + webproperty.getInternalWebPropertyId());

  System.out.println("Web Property Website URL: " + webproperty.getWebsiteUrl());
  System.out.println("Web Property Created: " + webproperty.getCreated());
  System.out.println("Web Property Updated: " + webproperty.getUpdated());
}

PHP

Uses the PHP client library

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

/**
 * Example #1:
 * Requests a list of all web properties for the account with ID 12345.
 */
try {
  $webProperties = analytics->management_webproperties
                            ->listManagementWebproperties('12345');

} 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 web properties for the user's account, using a
 * wildcard ~all as the accountId.
 */
$webProperties = analytics->management_webproperties
    ->listManagementWebproperties('~all');


/**
 * Example #3:
 * The results of the list method are stored in the Webproperties object. The following
 * code shows how to iterate through them.
 */
$html = '';
$items = $webproperties->getItems();

if (count($items) != 0) {
  foreach ($items as &$webproperty) {
    $html .= <<<HTML
<pre>

Account ID              = {$webproperty->getAccountId()}
Webproperty ID          = {$webproperty->getId()}
Webproperty Name        = {$webproperty->getName()}
Internal Webproperty ID = {$webproperty->getInternalWebPropertyId()}

Website URL             = {$webproperty->getWebsiteUrl()}
Created                 = {$webproperty->getCreated()}
Updated                 = {$webproperty->getUpdated()}

</pre>
HTML;
  }
}
print $html;

Python

Uses the Python client library

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


# Example #1:
# Requests a list of all web properties for the account with ID 12345.
try:
  webproperties = 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 ('Arg, there was an API error : %s : %s' %
      (error.resp.status, error._get_reason()))


# Example #2:
# Retrieves all web properties for the user's account, using a
# wildcard ~all as the accountId.
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 webproperty in webproperties_response.get('items', []):
  print 'Account ID         = %s' % webproperty.get('accountId')
  print 'Web Property ID    = %s' % webproperty.get('id')
  print 'Web Property Name  = %s' % webproperty.get('name')
  print 'Internal Web Property ID = %s' % webproperty.get('internalWebPropertyId')

  print 'Website URL        = %s' % webproperty.get('websiteUrl')
  print 'Created            = %s' % webproperty.get('created')
  print 'Updated            = %s' % webproperty.get('updated')

Try it!

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

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.