Google Analytics API . provisioning

close()

Close httplib2 connections.

createAccountTicket(body=None)

Creates an account ticket.

Args:
  body: object, The request body.
    The object takes the form of:

{ # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
  "account": { # JSON template for Analytics account entry. # Account for this ticket.
    "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
      "href": "A String", # Link to the list of web properties for this account.
      "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
    },
    "created": "A String", # Time the account was created.
    "id": "A String", # Account ID.
    "kind": "analytics#account", # Resource type for Analytics account.
    "name": "A String", # Account name.
    "permissions": { # Permissions the user has for this account.
      "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
        "A String",
      ],
    },
    "selfLink": "A String", # Link for this account.
    "starred": True or False, # Indicates whether this account is starred or not.
    "updated": "A String", # Time the account was last modified.
  },
  "id": "A String", # Account ticket ID used to access the account ticket.
  "kind": "analytics#accountTicket", # Resource type for account ticket.
  "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
    "accountId": "A String", # Account ID to which this view (profile) belongs.
    "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
    "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
      "href": "A String", # Link to the list of goals for this view (profile).
      "type": "analytics#goals", # Value is "analytics#goals".
    },
    "created": "A String", # Time this view (profile) was created.
    "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
        # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
    "defaultPage": "A String", # Default page for this view (profile).
    "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
    "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
    "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
    "id": "A String", # View (Profile) ID.
    "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
    "kind": "analytics#profile", # Resource type for Analytics view (profile).
    "name": "A String", # Name of this view (profile).
    "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
      "href": "A String", # Link to the web property to which this view (profile) belongs.
      "type": "analytics#webproperty", # Value is "analytics#webproperty".
    },
    "permissions": { # Permissions the user has for this view (profile).
      "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
        "A String",
      ],
    },
    "selfLink": "A String", # Link for this view (profile).
    "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
    "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
    "starred": True or False, # Indicates whether this view (profile) is starred or not.
    "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
    "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
    "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
    "type": "A String", # View (Profile) type. Supported types: WEB or APP.
    "updated": "A String", # Time this view (profile) was last modified.
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
    "websiteUrl": "A String", # Website URL for this view (profile).
  },
  "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
  "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
    "accountId": "A String", # Account ID to which this web property belongs.
    "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".
    },
    "created": "A String", # Time this web property was created.
    "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.
    "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
        # This property cannot be set on insert.
    "defaultProfileId": "A String", # Default view (profile) ID.
    "id": "A String", # Web property ID of the form UA-XXXXX-YY.
    "industryVertical": "A String", # The industry vertical/category selected for this web property.
    "internalWebPropertyId": "A String", # Internal ID for this web property.
    "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
    "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
    "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".
    },
    "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",
      ],
    },
    "profileCount": 42, # View (Profile) count for this web property.
    "selfLink": "A String", # Link for this web property.
    "starred": True or False, # Indicates whether this web property is starred or not.
    "updated": "A String", # Time this web property was last modified.
    "websiteUrl": "A String", # Website url for this web property.
  },
}


Returns:
  An object of the form:

    { # JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.
  "account": { # JSON template for Analytics account entry. # Account for this ticket.
    "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
      "href": "A String", # Link to the list of web properties for this account.
      "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
    },
    "created": "A String", # Time the account was created.
    "id": "A String", # Account ID.
    "kind": "analytics#account", # Resource type for Analytics account.
    "name": "A String", # Account name.
    "permissions": { # Permissions the user has for this account.
      "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
        "A String",
      ],
    },
    "selfLink": "A String", # Link for this account.
    "starred": True or False, # Indicates whether this account is starred or not.
    "updated": "A String", # Time the account was last modified.
  },
  "id": "A String", # Account ticket ID used to access the account ticket.
  "kind": "analytics#accountTicket", # Resource type for account ticket.
  "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
    "accountId": "A String", # Account ID to which this view (profile) belongs.
    "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
    "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
      "href": "A String", # Link to the list of goals for this view (profile).
      "type": "analytics#goals", # Value is "analytics#goals".
    },
    "created": "A String", # Time this view (profile) was created.
    "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
        # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
    "defaultPage": "A String", # Default page for this view (profile).
    "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
    "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
    "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
    "id": "A String", # View (Profile) ID.
    "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
    "kind": "analytics#profile", # Resource type for Analytics view (profile).
    "name": "A String", # Name of this view (profile).
    "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
      "href": "A String", # Link to the web property to which this view (profile) belongs.
      "type": "analytics#webproperty", # Value is "analytics#webproperty".
    },
    "permissions": { # Permissions the user has for this view (profile).
      "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
        "A String",
      ],
    },
    "selfLink": "A String", # Link for this view (profile).
    "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
    "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
    "starred": True or False, # Indicates whether this view (profile) is starred or not.
    "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
    "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
    "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
    "type": "A String", # View (Profile) type. Supported types: WEB or APP.
    "updated": "A String", # Time this view (profile) was last modified.
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
    "websiteUrl": "A String", # Website URL for this view (profile).
  },
  "redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.
  "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
    "accountId": "A String", # Account ID to which this web property belongs.
    "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".
    },
    "created": "A String", # Time this web property was created.
    "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.
    "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
        # This property cannot be set on insert.
    "defaultProfileId": "A String", # Default view (profile) ID.
    "id": "A String", # Web property ID of the form UA-XXXXX-YY.
    "industryVertical": "A String", # The industry vertical/category selected for this web property.
    "internalWebPropertyId": "A String", # Internal ID for this web property.
    "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
    "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
    "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".
    },
    "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",
      ],
    },
    "profileCount": 42, # View (Profile) count for this web property.
    "selfLink": "A String", # Link for this web property.
    "starred": True or False, # Indicates whether this web property is starred or not.
    "updated": "A String", # Time this web property was last modified.
    "websiteUrl": "A String", # Website url for this web property.
  },
}

createAccountTree(body=None)

Provision account.

Args:
  body: object, The request body.
    The object takes the form of:

{ # JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields.
  "accountName": "A String",
  "kind": "analytics#accountTreeRequest", # Resource type for account ticket.
  "profileName": "A String",
  "timezone": "A String",
  "webpropertyName": "A String",
  "websiteUrl": "A String",
}


Returns:
  An object of the form:

    { # JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile).
  "account": { # JSON template for Analytics account entry. # The account created.
    "childLink": { # Child link for an account entry. Points to the list of web properties for this account.
      "href": "A String", # Link to the list of web properties for this account.
      "type": "analytics#webproperties", # Type of the child link. Its value is "analytics#webproperties".
    },
    "created": "A String", # Time the account was created.
    "id": "A String", # Account ID.
    "kind": "analytics#account", # Resource type for Analytics account.
    "name": "A String", # Account name.
    "permissions": { # Permissions the user has for this account.
      "effective": [ # All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).
        "A String",
      ],
    },
    "selfLink": "A String", # Link for this account.
    "starred": True or False, # Indicates whether this account is starred or not.
    "updated": "A String", # Time the account was last modified.
  },
  "kind": "analytics#accountTreeResponse", # Resource type for account ticket.
  "profile": { # JSON template for an Analytics view (profile). # View (Profile) for the account.
    "accountId": "A String", # Account ID to which this view (profile) belongs.
    "botFilteringEnabled": True or False, # Indicates whether bot filtering is enabled for this view (profile).
    "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
      "href": "A String", # Link to the list of goals for this view (profile).
      "type": "analytics#goals", # Value is "analytics#goals".
    },
    "created": "A String", # Time this view (profile) was created.
    "currency": "A String", # The currency type associated with this view (profile), defaults to USD. The supported values are:
        # USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL
    "defaultPage": "A String", # Default page for this view (profile).
    "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
    "enhancedECommerceTracking": True or False, # Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.
    "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
    "id": "A String", # View (Profile) ID.
    "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
    "kind": "analytics#profile", # Resource type for Analytics view (profile).
    "name": "A String", # Name of this view (profile).
    "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
      "href": "A String", # Link to the web property to which this view (profile) belongs.
      "type": "analytics#webproperty", # Value is "analytics#webproperty".
    },
    "permissions": { # Permissions the user has for this view (profile).
      "effective": [ # All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.
        "A String",
      ],
    },
    "selfLink": "A String", # Link for this view (profile).
    "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
    "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
    "starred": True or False, # Indicates whether this view (profile) is starred or not.
    "stripSiteSearchCategoryParameters": True or False, # Whether or not Analytics will strip search category parameters from the URLs in your reports.
    "stripSiteSearchQueryParameters": True or False, # Whether or not Analytics will strip search query parameters from the URLs in your reports.
    "timezone": "A String", # Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.
    "type": "A String", # View (Profile) type. Supported types: WEB or APP.
    "updated": "A String", # Time this view (profile) was last modified.
    "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
    "websiteUrl": "A String", # Website URL for this view (profile).
  },
  "webproperty": { # JSON template for an Analytics web property. # Web property for the account.
    "accountId": "A String", # Account ID to which this web property belongs.
    "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".
    },
    "created": "A String", # Time this web property was created.
    "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.
    "dataRetentionTtl": "A String", # The length of time for which user and event data is retained.
        # This property cannot be set on insert.
    "defaultProfileId": "A String", # Default view (profile) ID.
    "id": "A String", # Web property ID of the form UA-XXXXX-YY.
    "industryVertical": "A String", # The industry vertical/category selected for this web property.
    "internalWebPropertyId": "A String", # Internal ID for this web property.
    "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
    "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
    "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".
    },
    "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",
      ],
    },
    "profileCount": 42, # View (Profile) count for this web property.
    "selfLink": "A String", # Link for this web property.
    "starred": True or False, # Indicates whether this web property is starred or not.
    "updated": "A String", # Time this web property was last modified.
    "websiteUrl": "A String", # Website url for this web property.
  },
}