Google Analytics API . management . webproperties

Instance Methods

list(accountId, max_results=None, start_index=None)

Lists web properties to which the user has access.

Method Details

list(accountId, max_results=None, start_index=None)
Lists web properties to which the user has access.

Args:
  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. (required)
  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.

Returns:
  An object of the form:

    { # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#webproperties", # Collection type.
    "items": [ # A list of web properties.
      { # JSON template for an Analytics web property.
        "websiteUrl": "A String", # Website url for this web property.
        "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
        "name": "A String", # Name of this web property.
        "created": "A String", # Time this web property was created.
        "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
        "updated": "A String", # Time this web property was last modified.
        "profileCount": 42, # View (Profile) count for this web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
          "href": "A String", # Link to the list of views (profiles) for this web property.
          "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
        },
        "industryVertical": "A String", # The industry vertical/category selected for this web property.
        "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
          "href": "A String", # Link to the account for this web property.
          "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
        },
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "selfLink": "A String", # Link for this web property.
        "accountId": "A String", # Account ID to which this web property belongs.
      },
    ],
    "itemsPerPage": 42, # 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.
    "previousLink": "A String", # Link to previous page for this web property collection.
    "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
    "nextLink": "A String", # Link to next page for this web property collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }