Google Analytics API . management . accountSummaries

Instance Methods

list(max_results=None, start_index=None)

Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

Method Details

list(max_results=None, start_index=None)
Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.

Args:
  max_results: integer, The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.
  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:

    { # An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.
    "username": "A String", # Email ID of the authenticated user
    "kind": "analytics#accountSummaries", # Collection type.
    "items": [ # A list of AccountSummaries.
      { # JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.
        "starred": True or False, # Indicates whether this account is starred or not.
        "kind": "analytics#accountSummary", # Resource type for Analytics AccountSummary.
        "webProperties": [ # List of web properties under this account.
          { # JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.
            "kind": "analytics#webPropertySummary", # Resource type for Analytics WebPropertySummary.
            "name": "A String", # Web property name.
            "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
            "profiles": [ # List of profiles under this web property.
              { # JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.
                "starred": True or False, # Indicates whether this view (profile) is starred or not.
                "kind": "analytics#profileSummary", # Resource type for Analytics ProfileSummary.
                "type": "A String", # View (Profile) type. Supported types: WEB or APP.
                "id": "A String", # View (profile) ID.
                "name": "A String", # View (profile) name.
              },
            ],
            "websiteUrl": "A String", # Website url for this web property.
            "internalWebPropertyId": "A String", # Internal ID for this web property.
            "starred": True or False, # Indicates whether this web property is starred or not.
            "id": "A String", # Web property ID of the form UA-XXXXX-YY.
          },
        ],
        "id": "A String", # Account ID.
        "name": "A String", # Account name.
      },
    ],
    "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 AccountSummary 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 AccountSummary collection.
    "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
  }