Merge pull request #1056 from PiwikPRO/master

master -> 18.1
PiwikPRO · Aug 22, 2023 · e7bc352 · e7bc352
2 parents 0c09d5e + 6f10a16
commit e7bc352
Show file tree

Hide file tree

Showing 6 changed files with 93 additions and 32 deletions.
diff --git a/_templates/layout.html b/_templates/layout.html
@@ -86,7 +86,7 @@
         activeMenu.classList.add('active', 'current');
     }
     if(topbarLinks) {
-        topbarLinks[2].innerHTML += '<div class="Badge blue" style="display: inline-block;"><div class="BadgeInner"><div class="BadgeText">BETA</div></div></div>'
+        topbarLinks[2].innerHTML += '<div class="Badge blue" style="display: inline-block;"><div class="BadgeInner"><div class="BadgeText">NEW</div></div></div>'
         topbarLinks[6].innerHTML += '<div class="Badge gray" style="display: inline-block;"><div class="BadgeInner"><div class="BadgeText">OLD</div></div></div>'
     }
     let breadCrumbs = document.querySelector('.wy-breadcrumbs');

diff --git a/customer_data_platform/authorized_api/customer_data_platform_activations_api.yaml b/customer_data_platform/authorized_api/customer_data_platform_activations_api.yaml
@@ -274,7 +274,7 @@ components:
           type: array
           items:
             $ref: '../components.yaml#/components/schemas/ConsentType'
-          example: ["remarketing", "ab_testing"]
+          example: ["ab_testing_and_personalization", "remarketing"]
     Activation:
       description: An object representing activation with all data for display
       required:
@@ -376,7 +376,7 @@ components:
           type: array
           items:
             $ref: '../components.yaml#/components/schemas/ConsentType'
-          example: ["remarketing", "ab_testing"]
+          example: ["ab_testing_and_personalization", "remarketing"]
         multiple:
           description: Activate single profile multiple times, regardless if it was already activated
           type: boolean
@@ -447,7 +447,7 @@ components:
           type: array
           items:
             $ref: '../components.yaml#/components/schemas/ConsentType'
-          example: ["remarketing", "ab_testing"]
+          example: ["ab_testing_and_personalization", "remarketing"]
         multiple:
           description: Activate single profile multiple times, regardless if it was already activated
           type: boolean

diff --git a/customer_data_platform/components.yaml b/customer_data_platform/components.yaml
@@ -272,13 +272,13 @@ components:
       description: Actions a visitor may give consent for
       type: string
       enum:
-        - ab_testing
         - analytics
-        - conversion
-        - marketing
+        - ab_testing_and_personalization
+        - conversion_tracking
+        - marketing_automation
         - remarketing
         - user_feedback
-        - custom1
+        - custom_consent
     Definition:
       description: Audience definition
       type: object

diff --git a/data_collection/api/tracking_api.yaml b/data_collection/api/tracking_api.yaml
@@ -22,13 +22,15 @@ paths:
       parameters:
         - name: idsite
           in: query
-          description: Application ID (previously Website ID).
-          required: true
+          description: |
+            **Recommended** Application ID (previously Website ID).
+
+            *IMPORTANT*: Requests should contain `idsite` parameter with actual UUID of one of your apps, otherwise they won't appear in reports.
           schema:
             type: string
             format: UUID
-            minLength: 32
-            maxLength: 32
+            minLength: 36
+            maxLength: 36
           example: 892d04bd-6e2b-4914-bfb4-bac721b37235
         - name: rec
           in: query

diff --git a/data_collection/web/javascript_tracking_client/api.rst b/data_collection/web/javascript_tracking_client/api.rst
@@ -281,6 +281,7 @@ E-commerce v2
         * quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
         * brand - **Optional** [string] Product brand (default: "")
         * variant - **Optional** [string] Product variant (default: "")
+        * customDimensions - **Optional** [object] Product custom dimensions (default: {})
 
     Example of usage:
 
@@ -299,7 +300,11 @@ E-commerce v2
                         price: "49.90",
                         quantity: 3,
                         brand: "DMZ",
-                        variant: "blue"
+                        variant: "blue",
+                        customDimensions: {
+                            1: 'coupon-2020',
+                            2: '20%'
+                        }
                     }]
                 ]);
 
@@ -314,7 +319,11 @@ E-commerce v2
                     price: "49.90",
                     quantity: 3,
                     brand: "DMZ",
-                    variant: "blue"
+                    variant: "blue",
+                    customDimensions: {
+                        1: 'coupon-2020',
+                        2: '20%'
+                    }
                 }]);
 
 .. _jtc-api-ecommerceAddToCart:
@@ -332,6 +341,7 @@ E-commerce v2
         * quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
         * brand - **Optional** [string] Product brand (default: "")
         * variant - **Optional** [string] Product variant (default: "")
+        * customDimensions - **Optional** [object] Product custom dimensions (default: {})
 
     Example of usage:
 
@@ -350,7 +360,11 @@ E-commerce v2
                         price: "49.90",
                         quantity: 3,
                         brand: "DMZ",
-                        variant: "blue"
+                        variant: "blue",
+                        customDimensions: {
+                            1: 'coupon-2020',
+                            2: '20%'
+                        }
                     }]
                 ]);
 
@@ -365,7 +379,11 @@ E-commerce v2
                     price: "49.90",
                     quantity: 3,
                     brand: "DMZ",
-                    variant: "blue"
+                    variant: "blue",
+                    customDimensions: {
+                        1: 'coupon-2020',
+                        2: '20%'
+                    }
                 }]);
 
 .. _jtc-api-ecommerceRemoveFromCart:
@@ -383,6 +401,7 @@ E-commerce v2
         * quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
         * brand - **Optional** [string] Product brand (default: "")
         * variant - **Optional** [string] Product variant (default: "")
+        * customDimensions - **Optional** [object] Product custom dimensions (default: {})
 
     Example of usage:
 
@@ -401,7 +420,11 @@ E-commerce v2
                         price: "49.90",
                         quantity: 3,
                         brand: "DMZ",
-                        variant: "blue"
+                        variant: "blue",
+                        customDimensions: {
+                            1: 'coupon-2020',
+                            2: '20%'
+                        }
                     }]
                 ]);
 
@@ -416,7 +439,11 @@ E-commerce v2
                     price: "49.90",
                     quantity: 3,
                     brand: "DMZ",
-                    variant: "blue"
+                    variant: "blue",
+                    customDimensions: {
+                        1: 'coupon-2020',
+                        2: '20%'
+                    }
                 }]);
 
 .. _jtc-api-ecommerceCartUpdate:
@@ -434,6 +461,7 @@ E-commerce v2
         * quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
         * brand - **Optional** [string] Product brand (default: "")
         * variant - **Optional** [string] Product variant (default: "")
+        * customDimensions - **Optional** [object] Product custom dimensions (default: {})
 
     :param number grandTotal: **Required** [number|string] The total value of items in a cart has to be a float number or a string containing float number representation
 
@@ -455,7 +483,11 @@ E-commerce v2
                             price: "50.00",
                             quantity: 3,
                             brand: "DMZ",
-                            variant: "blue"
+                            variant: "blue",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         },
                         {
                             sku: "craft-312",
@@ -464,7 +496,11 @@ E-commerce v2
                             price: "30.00",
                             quantity: 1,
                             brand: "DMZ",
-                            variant: "red"
+                            variant: "red",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         }
                     ],
                     "180.00"
@@ -483,7 +519,11 @@ E-commerce v2
                             price: "50.00",
                             quantity: 3,
                             brand: "DMZ",
-                            variant: "blue"
+                            variant: "blue",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         },
                         {
                             sku: "craft-312",
@@ -492,7 +532,11 @@ E-commerce v2
                             price: "30.00",
                             quantity: 1,
                             brand: "DMZ",
-                            variant: "red"
+                            variant: "red",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         }
                     ],
                     "180.00"
@@ -513,6 +557,7 @@ E-commerce v2
         * quantity - **Optional** [number|string] Product quantity has to be an integer number or a string containing integer representation (default: 1)
         * brand - **Optional** [string] Product brand (default: "")
         * variant - **Optional** [string] Product variant (default: "")
+        * customDimensions - **Optional** [object] Product custom dimensions (default: {})
 
     :param object paymentInformation: Total payment information about products in a cart. Expected attributes:
 
@@ -541,7 +586,11 @@ E-commerce v2
                             price: "50.00",
                             quantity: 3,
                             brand: "DMZ",
-                            variant: "blue"
+                            variant: "blue",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         },
                         {
                             sku: "craft-312",
@@ -550,7 +599,11 @@ E-commerce v2
                             price: "30.00",
                             quantity: 1,
                             brand: "DMZ",
-                            variant: "red"
+                            variant: "red",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         }
                     ],
                     {
@@ -576,7 +629,11 @@ E-commerce v2
                             price: "50.00",
                             quantity: 3,
                             brand: "DMZ",
-                            variant: "blue"
+                            variant: "blue",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         },
                         {
                             sku: "craft-312",
@@ -585,7 +642,11 @@ E-commerce v2
                             price: "30.00",
                             quantity: 1,
                             brand: "DMZ",
-                            variant: "red"
+                            variant: "red",
+                            customDimensions: {
+                                1: 'coupon-2020',
+                                2: '20%'
+                            }
                         }
                     ],
                     {

diff --git a/platform/authorized_api/modules/public_v1.yaml b/platform/authorized_api/modules/public_v1.yaml
@@ -229,11 +229,10 @@ components:
         type: string
         enum:
           - analytics
-          - piwik
           - consent_manager
+          - customer_data_platform
           - tag_manager
           - administration
-          - audience_manager
     UserId:
       in: path
       name: user_id
@@ -255,8 +254,8 @@ components:
                     - status: "404"
                       code: module.not-exists
                       title: Module 'personalization' does not exist. Available
-                        modules are [analytics, piwik, consent_manager,
-                        tag_manager, administration, audience_manager]
+                        modules are [analytics, consent_manager, customer_data_platform,
+                        tag_manager, administration]
     NotFoundUser:
       description: Not Found
       content:
@@ -390,11 +389,10 @@ components:
       type: string
       enum:
         - analytics
-        - piwik
         - consent_manager
+        - customer_data_platform
         - tag_manager
         - administration
-        - audience_manager
       description: ID of a module
     UserIdentifier:
       type: object