# Google Analytics API . management . webproperties

## Instance Methods

Gets a web property to which the user has access.

Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.

Lists web properties to which the user has access.

Updates an existing web property. This method supports patch semantics.

Updates an existing web property.

### Method Details

`get(accountId, webPropertyId)`

    Gets a web property to which the user has access.

    Args:
      accountId: string, Account ID to retrieve the web property for. (required)
      webPropertyId: string, ID to retrieve the web property for. (required)

    Returns:
      An object of the form:

        { # JSON template for an Analytics web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
        "created": "A String", # Time this web property was created.
        "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
            # This property cannot be set on insert.
        "websiteUrl": "A String", # Website url for this web property.
        "name": "A String", # Name of 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".
        },
        "accountId": "A String", # Account ID to which this web property belongs.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "defaultProfileId": "A String", # Default view (profile) ID.
        "profileCount": 42, # View (Profile) count for this web property.
        "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
            # Set to false to delete data associated with the user identifier automatically after the rentention period.
            # This property cannot be set on insert.
        "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
          "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
          "href": "A String", # Link to the list of views (profiles) for this web property.
        },
        "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
        "permissions": { # Permissions the user has for this web property.
          "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
            "A String",
          ],
        },
        "industryVertical": "A String", # The industry vertical/category selected for this web property.
        "selfLink": "A String", # Link for this web property.
        "updated": "A String", # Time this web property was last modified.
        "starred": True or False, # Indicates whether this web property is starred or not.
      }

`insert(accountId, body=None)`

    Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.

    Args:
      accountId: string, Account ID to create the web property for. (required)
      body: object, The request body.
        The object takes the form of:

    { # JSON template for an Analytics web property.
      "internalWebPropertyId": "A String", # Internal ID for this web property.
      "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
      "created": "A String", # Time this web property was created.
      "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
          # This property cannot be set on insert.
      "websiteUrl": "A String", # Website url for this web property.
      "name": "A String", # Name of 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".
      },
      "accountId": "A String", # Account ID to which this web property belongs.
      "id": "A String", # Web property ID of the form UA-XXXXX-YY.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "profileCount": 42, # View (Profile) count for this web property.
      "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
          # Set to false to delete data associated with the user identifier automatically after the rentention period.
          # This property cannot be set on insert.
      "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
        "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
        "href": "A String", # Link to the list of views (profiles) for this web property.
      },
      "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "industryVertical": "A String", # The industry vertical/category selected for this web property.
      "selfLink": "A String", # Link for this web property.
      "updated": "A String", # Time this web property was last modified.
      "starred": True or False, # Indicates whether this web property is starred or not.
    }

    Returns:
      An object of the form:

        { # JSON template for an Analytics web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
        "created": "A String", # Time this web property was created.
        "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
            # This property cannot be set on insert.
        "websiteUrl": "A String", # Website url for this web property.
        "name": "A String", # Name of 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".
        },
        "accountId": "A String", # Account ID to which this web property belongs.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "defaultProfileId": "A String", # Default view (profile) ID.
        "profileCount": 42, # View (Profile) count for this web property.
        "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
            # Set to false to delete data associated with the user identifier automatically after the rentention period.
            # This property cannot be set on insert.
        "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
          "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
          "href": "A String", # Link to the list of views (profiles) for this web property.
        },
        "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
        "permissions": { # Permissions the user has for this web property.
          "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
            "A String",
          ],
        },
        "industryVertical": "A String", # The industry vertical/category selected for this web property.
        "selfLink": "A String", # Link for this web property.
        "updated": "A String", # Time this web property was last modified.
        "starred": True or False, # Indicates whether this web property is starred or not.
      }

`list(accountId, start_index=None, max_results=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)
      start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
      max_results: integer, The maximum number of web properties to include in this response.

    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.
        "nextLink": "A String", # Link to next page for this web property collection.
        "previousLink": "A String", # Link to previous 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.
        "items": [ # A list of web properties.
          { # JSON template for an Analytics web property.
            "internalWebPropertyId": "A String", # Internal ID for this web property.
            "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
            "created": "A String", # Time this web property was created.
            "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
                # This property cannot be set on insert.
            "websiteUrl": "A String", # Website url for this web property.
            "name": "A String", # Name of 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".
            },
            "accountId": "A String", # Account ID to which this web property belongs.
            "id": "A String", # Web property ID of the form UA-XXXXX-YY.
            "defaultProfileId": "A String", # Default view (profile) ID.
            "profileCount": 42, # View (Profile) count for this web property.
            "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
                # Set to false to delete data associated with the user identifier automatically after the rentention period.
                # This property cannot be set on insert.
            "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
              "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
              "href": "A String", # Link to the list of views (profiles) for this web property.
            },
            "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
            "permissions": { # Permissions the user has for this web property.
              "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
                "A String",
              ],
            },
            "industryVertical": "A String", # The industry vertical/category selected for this web property.
            "selfLink": "A String", # Link for this web property.
            "updated": "A String", # Time this web property was last modified.
            "starred": True or False, # Indicates whether this web property is starred or not.
          },
        ],
        "username": "A String", # Email ID of the authenticated user
        "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.
        "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
        "kind": "analytics#webproperties", # Collection type.
      }

`patch(accountId, webPropertyId, body=None)`

    Updates an existing web property. This method supports patch semantics.

    Args:
      accountId: string, Account ID to which the web property belongs (required)
      webPropertyId: string, Web property ID (required)
      body: object, The request body.
        The object takes the form of:

    { # JSON template for an Analytics web property.
      "internalWebPropertyId": "A String", # Internal ID for this web property.
      "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
      "created": "A String", # Time this web property was created.
      "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
          # This property cannot be set on insert.
      "websiteUrl": "A String", # Website url for this web property.
      "name": "A String", # Name of 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".
      },
      "accountId": "A String", # Account ID to which this web property belongs.
      "id": "A String", # Web property ID of the form UA-XXXXX-YY.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "profileCount": 42, # View (Profile) count for this web property.
      "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
          # Set to false to delete data associated with the user identifier automatically after the rentention period.
          # This property cannot be set on insert.
      "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
        "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
        "href": "A String", # Link to the list of views (profiles) for this web property.
      },
      "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "industryVertical": "A String", # The industry vertical/category selected for this web property.
      "selfLink": "A String", # Link for this web property.
      "updated": "A String", # Time this web property was last modified.
      "starred": True or False, # Indicates whether this web property is starred or not.
    }

    Returns:
      An object of the form:

        { # JSON template for an Analytics web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
        "created": "A String", # Time this web property was created.
        "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
            # This property cannot be set on insert.
        "websiteUrl": "A String", # Website url for this web property.
        "name": "A String", # Name of 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".
        },
        "accountId": "A String", # Account ID to which this web property belongs.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "defaultProfileId": "A String", # Default view (profile) ID.
        "profileCount": 42, # View (Profile) count for this web property.
        "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
            # Set to false to delete data associated with the user identifier automatically after the rentention period.
            # This property cannot be set on insert.
        "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
          "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
          "href": "A String", # Link to the list of views (profiles) for this web property.
        },
        "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
        "permissions": { # Permissions the user has for this web property.
          "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
            "A String",
          ],
        },
        "industryVertical": "A String", # The industry vertical/category selected for this web property.
        "selfLink": "A String", # Link for this web property.
        "updated": "A String", # Time this web property was last modified.
        "starred": True or False, # Indicates whether this web property is starred or not.
      }

`update(accountId, webPropertyId, body=None)`

    Updates an existing web property.

    Args:
      accountId: string, Account ID to which the web property belongs (required)
      webPropertyId: string, Web property ID (required)
      body: object, The request body.
        The object takes the form of:

    { # JSON template for an Analytics web property.
      "internalWebPropertyId": "A String", # Internal ID for this web property.
      "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
      "created": "A String", # Time this web property was created.
      "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
          # This property cannot be set on insert.
      "websiteUrl": "A String", # Website url for this web property.
      "name": "A String", # Name of 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".
      },
      "accountId": "A String", # Account ID to which this web property belongs.
      "id": "A String", # Web property ID of the form UA-XXXXX-YY.
      "defaultProfileId": "A String", # Default view (profile) ID.
      "profileCount": 42, # View (Profile) count for this web property.
      "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
          # Set to false to delete data associated with the user identifier automatically after the rentention period.
          # This property cannot be set on insert.
      "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
        "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
        "href": "A String", # Link to the list of views (profiles) for this web property.
      },
      "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
      "permissions": { # Permissions the user has for this web property.
        "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
          "A String",
        ],
      },
      "industryVertical": "A String", # The industry vertical/category selected for this web property.
      "selfLink": "A String", # Link for this web property.
      "updated": "A String", # Time this web property was last modified.
      "starred": True or False, # Indicates whether this web property is starred or not.
    }

    Returns:
      An object of the form:

        { # JSON template for an Analytics web property.
        "internalWebPropertyId": "A String", # Internal ID for this web property.
        "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
        "created": "A String", # Time this web property was created.
        "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
            # This property cannot be set on insert.
        "websiteUrl": "A String", # Website url for this web property.
        "name": "A String", # Name of 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".
        },
        "accountId": "A String", # Account ID to which this web property belongs.
        "id": "A String", # Web property ID of the form UA-XXXXX-YY.
        "defaultProfileId": "A String", # Default view (profile) ID.
        "profileCount": 42, # View (Profile) count for this web property.
        "dataRetentionResetOnNewActivity": True or False, # Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).
            # Set to false to delete data associated with the user identifier automatically after the rentention period.
            # This property cannot be set on insert.
        "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
          "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
          "href": "A String", # Link to the list of views (profiles) for this web property.
        },
        "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
        "permissions": { # Permissions the user has for this web property.
          "effective": [ # All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.
            "A String",
          ],
        },
        "industryVertical": "A String", # The industry vertical/category selected for this web property.
        "selfLink": "A String", # Link for this web property.
        "updated": "A String", # Time this web property was last modified.
        "starred": True or False, # Indicates whether this web property is starred or not.
      }