Skip to content

Latest commit

 

History

History
260 lines (205 loc) · 10.7 KB

releases.md

File metadata and controls

260 lines (205 loc) · 10.7 KB

Release info

This page will give you the change that are occuring when a new version has been published on pypi. The changes have been tracked starting version 0.1.0

version 0.4.2

  • adding getAlerts method
  • adding classifications methods.
    • getClassificationDatasets
    • getClassificationDataset
    • getClassificationJobs
    • getClassificationJob
    • deleteClassification
    • importClassification
    • createExportClassification
    • getExportClassificationFile
    • getClassificationTemplate
  • adding datawarehouse methods.
    • getDataWarehouseReports
    • getDataWarehouseReport
    • resendDataWarehouseReport
    • getDataWarehouseScheduledRequests
    • getDataWarehouseScheduledRequest
      Patch :
  • fixing issue on getClassificationDatasets method
  • adding more methods to classication
  • improving standard for retry parameters.
  • adding capability for reading reports (summary, trended and ranked) out of the 1.4 Reporting API via transformReportToDataFrame (see LegacyAnalytics)
  • adding the createDataWarehouseScheduledRequest method
  • adding the ReportBuilder14 class for building query on legacy API (see LegacyAnalytics)

version 0.4.1

  • updating legacy methods to support new system
  • migrating to V3 auth token generation
  • fixing the Project class for dynamic dimensions
  • supporting pandas 2.0.0 for concatenation
    Patch:
  • fix on full extract for dimensions and metrics.
  • fix on save to getReport2
  • adding support for other folder location for ingestion files.

version 0.4.0

  • supporting Oauth Token V2
  • Oauth Token V2 is the new default support when creating a config file
  • better respecting existing parameter via getReport2
  • raising exception on error for generating token
  • deepcopying the request made to getReport2 method to avoid modification on original variable.
  • supporting passing the format parameter to be a logger.setFormatter() instance when passing the logger object.
    PATCH:
  • adding the validateProject method
  • Supporting the old version for the legacy retrieveToken method with the new method for JWT.
  • changing some methods to support new pandas version

version 0.3.3

  • adding the width parameter on scheduling report.
  • parameterization of the logger generation + add new info for logging info on GET requests Patch: \
  • adding shareComponent method (from @loldenburg)
  • resolving metrics name (from @loldenburg)
  • fixing issue when using dynamic filter on report for getReport2 method.
  • supporting requests for getReport2 for static row and resolve column
  • fix issue that getReport2 does not respect the JSON configure option for none-behavior and countRepeatInstances

version 0.3.2

  • Adding annotation methods
    • getAnnotations
    • getAnnotation
    • createAnnotation
    • updateAnnotation
    • deleteAnnotation
  • Add a getDateRange method

version 0.3.1

  • adding the workspace module that allow more dynamic and better presentation of the data. Documentation
  • adding the getReport2 method and documentation
  • Improving the RequestCreator class by adding
    • easy load of JSON files
    • capability to setSearch
    • remove all metrics
  • Support RequestCreator instance in the getReport methods
  • adding more scheduleJob methods:
    • getScheduledJob for specific job
    • createScheduledJob
    • deleteScheduledJob
    • updateScheduledJob
    • getDeliverySettings
    • getDeliverySetting
    • createDeliverySetting
    • updateDeliverySetting
    • deleteDeliverySetting
  • adding update methods documentation
  • Fixing references of the EventType for Audit Log LOGS_EVENT_TYPE attribute.
    Patch:
  • renaming some scheduleReport method typo.
  • supporting old report request without statistics info

version 0.3.0

  • Fix an issue where segments were not considered in findComponentUsage when they were used in columns
  • adding RequestCreator class (documentation)
  • fix issue when logging object error the output of failed calls.
    Patch :
  • adding encoding capability for validation and sendFiles method in the Bulkapi class.
  • Improving consistency for reading project dictionaries on Project class instanciation

version 0.2.9

  • Adding the getScheduledJobs endpoint
  • Adding logging capability (documentation)
  • Fixing some typo on regex used for findComponentUsage
  • Adding better docstring for some methods. Patches:
  • Fix issue on getScheduleJobs
  • improve createConfigFile method
  • improving Documentation
  • adding better log from the GET requests

version 0.2.8

  • adding the decodeAArequests method (documentation).
  • upgrading requirement libraries
  • cleaning legacy methods not supported anymore (getData,postData,putData,deleteData,getCompanyId) Patch:
  • adding deleteDateRange method
  • changing requirements back for pandas to 0.25.3

version 0.2.7

  • adding compareReportSuites method. (documentation)
  • adding reportType as attribute from projects. Either desktop or mobile
  • adding version and curation attributes by default on dict version of project
  • adding scanSegment and scanCalculatedMetric methods. (documentation)
  • adding rsidSuffix parameter for Project class (documentation), findComponentUsage (documentation) and getAllProjectDetails (documentation)
    Patch:
  • Adding description parameter option in getMetrics
  • Most of save parameter will get timestamp
  • Fix rsidPrefix as rsidSuffix parameter for findComponentUsage method.
  • Fix generator exhausted when trying to use recursive mode in findComponentUsage.
  • Change default comparison to retrieve all columns from dimensions and metrics.
  • Change search for elements to support rsidSuffix in findComponentUsage
  • fixed scan when no segment are used.

version 0.2.6

  • getSegments and getMetrics return now shares information
  • adding 429 status code handling for delete and patch requests.
  • adding cache option parameter for getProjects, getProject and getAllProjectDetails
  • Fixing Project class that was expecting global filters to be used.

version 0.2.5

  • adding limited capability for 1.4 API see documentation
  • Sepearating the Project Class to its own submodule
  • Improve classes representation
  • Adding getAllProjectDetails method
  • Adding projectsDetails attributes on the Analytics instance that stores the projectDetail in a dictionary.
  • Adding listProjectIds attributes that stores the result of getProjects method in a raw format.
  • Adding the getCalculatedMetric method in the module.
  • Adding validate methods for calculatedMetric and Segment
  • Update documentation for Projects elements

version 0.2.4

  • adding missing dependency file
  • adding the getTopItems method

version 0.2.3

  • Better error description when receiving report without lastPage key.
  • Adding the User Logs Usage endpoint.
  • Adding attribute restTime on Connector class to modify the waiting time when reaching error 429 (Too many requests)
  • Better handling of the 429 error for the GET method. Not required to have a the retry parameter.

version 0.2.2

  • fix issue when token needed to be updated after 24h.

version 0.2.1

  • fix issue on _checkingDate method in AdobeRequest

version 0.2.0

  • Upgrade compatibility for PyJWT 2.0.0.
  • Fix return element for sendFiles method on the Bulkapi class for ingestion method.
  • Improve management of throttle limit for getReport.

version 0.1.9

  • Fix default statement for getVirtualReportSuite that save the result automatically.
  • Improve return type statement

version 0.1.8

  • Fix legacy method to retrieve token that was broken by the new capability.

version 0.1.7

  • Adding an optional parameter to pass directly the private.key as a string to the configure method
  • Update documentation get-started & docstring for configure method.

version 0.1.6

  • Improving documentation
  • Fixing duplication for Project class analyzer.
    Now elementsUsed & nbElementsUsed are using deduplicated values.
  • Adding updateProject and createProject methods (beta - not tested)

version 0.1.5

  • Improving retry parameter behavior on GET methods
  • Improving Project class consistency

version 0.1.4

  • Dropping usage of modules.py for handling dependency
  • Fix updateDateRanges and updateVirtualReportSuite
  • Adding Projects endpoints (getProjects, getProject, deleteProject)
  • Adding Project Data class to easily extract information of project

version 0.1.3

  • adding support for the Tags components
  • adding new API for connecting without a config file
  • update documentation for server connection

version 0.1.2

  • adding the updateVirtualReportSuite method
  • adding the updateCalculatedMetrics method
  • update deleteCalculatedMetrics to deleteCalculatedMetric
  • update getCalculatedMetrics to respect the inclType as parameter.
  • update getVirtualReportSuites to add the inclType parameter
  • fix modules importing in the ingestion module
  • fix header on Bulk Ingestion API class.

version 0.1.1

  • update the getReport method with limit parameter
  • rename "Loggin" class to "Login" class.
  • update documentation

Version 0.1.0

  • Changing Architecture on the requests to Adobe Analytics API for the main class. This add the following functionalities:
    • retry parameter : a parameter that set the number of time you want to retry a GET method if the first one fails.
    • independance between Analytics instances : possibility to use the same script for 2 loggins company or even 2 experiences clouds API access.
    • Possibility to start directly with Analytics class if you already know you companyId.
  • Adding a new class Loggin that enables you to retrive the companyId
  • Ensuring that legacy methods (getCompanyId) is still available from the main module.
  • Adding test for GET methods of the core library (Analytics class)
  • Adding test documentation for setting tests
  • Adding release information