From 73d2f81cd5ce1d9124967f71b75a17b432b6fdc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Fr=C4=85ckowiak?= Date: Tue, 19 Sep 2023 11:33:58 +0200 Subject: [PATCH] TM-12931 Update Tag Manager API docs - Release 18.2.0 --- .../request/ecommerce_cart_update_create.json | 86 +++++++++++++ .../create/tags_create_request_schema.json | 3 + .../create/tags_create_response_schema.json | 3 + .../request/ecommerce_cart_update_edit.json | 79 ++++++++++++ .../schema/edit/tags_edit_request_schema.json | 3 + .../response/ecommerce_cart_update_get.json | 114 ++++++++++++++++++ .../schema/get/tags_get_response_schema.json | 3 + .../src/tags/schema/tag_attributes.json | 3 +- .../ecommerce_cart_update_attributes.json | 45 +++++++ .../ecommerce_cart_update_attributes_get.json | 47 ++++++++ .../tag_templates/piwik_attributes.json | 5 +- 11 files changed, 388 insertions(+), 3 deletions(-) create mode 100644 tag_manager/authorized_api/src/tags/schema/create/request/ecommerce_cart_update_create.json create mode 100644 tag_manager/authorized_api/src/tags/schema/edit/request/ecommerce_cart_update_edit.json create mode 100644 tag_manager/authorized_api/src/tags/schema/get/response/ecommerce_cart_update_get.json create mode 100644 tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes.json create mode 100644 tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes_get.json diff --git a/tag_manager/authorized_api/src/tags/schema/create/request/ecommerce_cart_update_create.json b/tag_manager/authorized_api/src/tags/schema/create/request/ecommerce_cart_update_create.json new file mode 100644 index 00000000..0f637729 --- /dev/null +++ b/tag_manager/authorized_api/src/tags/schema/create/request/ecommerce_cart_update_create.json @@ -0,0 +1,86 @@ +{ + "title": "Ecommerce Cart update", + "description": "Ecommerce Cart update create request", + "type": "object", + "properties": { + "data": { + "title": "JSON:API 1.0 request data", + "type": "object", + "properties": { + "id": { + "$ref": "../../tag_types.json#/definitions/tag_identifier" + }, + "type": { + "$ref": "../../tag_types.json#/definitions/tag_resource_type" + }, + "attributes": { + "description": "Ecommerce Cart update attributes", + "type": "object", + "properties": { + "disable_in_debug_mode": { + "$ref": "../../tag_attributes.json#/definitions/disable_in_debug_mode" + }, + "is_active": { + "$ref": "../../tag_attributes.json#/definitions/is_active" + }, + "priority": { + "$ref": "../../tag_attributes.json#/definitions/priority" + }, + "name": { + "$ref": "../../tag_attributes.json#/definitions/name" + }, + "respect_visitors_privacy": { + "$ref": "../../tag_attributes.json#/definitions/respect_visitors_privacy" + }, + "scheduler": { + "$ref": "../../tag_attributes.json#/definitions/scheduler" + }, + "consent_type": { + "$ref": "../../tag_attributes.json#/definitions/consent_type" + }, + "template": { + "$ref": "../../tag_templates/ecommerce/ecommerce_cart_update_attributes.json#/definitions/template" + }, + "template_options": { + "$ref": "../../tag_templates/ecommerce/ecommerce_cart_update_attributes.json#/definitions/template_options" + } + }, + "additionalProperties": false, + "required": [ + "name", + "template", + "template_options" + ] + }, + "relationships": { + "allOf": [ + { + "$ref": "../../tag_types.json#/definitions/relationships_description" + }, + { + "type": "object", + "properties": { + "triggers": { + "$ref": "../../tag_types.json#/definitions/trigger_relationship" + } + }, + "additionalProperties": false, + "required": [ + "triggers" + ] + } + ] + } + }, + "additionalProperties": false, + "required": [ + "type", + "attributes" + ] + } + }, + "additionalProperties": false, + "required": [ + "data" + ] +} diff --git a/tag_manager/authorized_api/src/tags/schema/create/tags_create_request_schema.json b/tag_manager/authorized_api/src/tags/schema/create/tags_create_request_schema.json index 0decdb02..90fbaf32 100644 --- a/tag_manager/authorized_api/src/tags/schema/create/tags_create_request_schema.json +++ b/tag_manager/authorized_api/src/tags/schema/create/tags_create_request_schema.json @@ -126,6 +126,9 @@ }, { "$ref": "request/ecommerce_product_detail_view_create.json" + }, + { + "$ref": "request/ecommerce_cart_update_create.json" } ] } diff --git a/tag_manager/authorized_api/src/tags/schema/create/tags_create_response_schema.json b/tag_manager/authorized_api/src/tags/schema/create/tags_create_response_schema.json index 23fda831..20526818 100644 --- a/tag_manager/authorized_api/src/tags/schema/create/tags_create_response_schema.json +++ b/tag_manager/authorized_api/src/tags/schema/create/tags_create_response_schema.json @@ -126,6 +126,9 @@ }, { "$ref": "../get/response/ecommerce_product_detail_view_get.json" + }, + { + "$ref": "../get/response/ecommerce_cart_update_get.json" } ] } diff --git a/tag_manager/authorized_api/src/tags/schema/edit/request/ecommerce_cart_update_edit.json b/tag_manager/authorized_api/src/tags/schema/edit/request/ecommerce_cart_update_edit.json new file mode 100644 index 00000000..1f47d653 --- /dev/null +++ b/tag_manager/authorized_api/src/tags/schema/edit/request/ecommerce_cart_update_edit.json @@ -0,0 +1,79 @@ +{ + "title": "Ecommerce Cart update", + "description": "Ecommerce Cart update edit request", + "type": "object", + "properties": { + "data": { + "title": "JSON:API 1.0 request data", + "type": "object", + "properties": { + "id": { + "$ref": "../../tag_types.json#/definitions/tag_identifier" + }, + "type": { + "$ref": "../../tag_types.json#/definitions/tag_resource_type" + }, + "attributes": { + "description": "Ecommerce Cart update attributes", + "type": "object", + "properties": { + "disable_in_debug_mode": { + "$ref": "../../tag_attributes.json#/definitions/disable_in_debug_mode" + }, + "is_active": { + "$ref": "../../tag_attributes.json#/definitions/is_active" + }, + "priority": { + "$ref": "../../tag_attributes.json#/definitions/priority" + }, + "name": { + "$ref": "../../tag_attributes.json#/definitions/name" + }, + "respect_visitors_privacy": { + "$ref": "../../tag_attributes.json#/definitions/respect_visitors_privacy" + }, + "scheduler": { + "$ref": "../../tag_attributes.json#/definitions/scheduler" + }, + "consent_type": { + "$ref": "../../tag_attributes.json#/definitions/consent_type" + }, + "template_options": { + "$ref": "../../tag_templates/ecommerce/ecommerce_cart_update_attributes.json#/definitions/template_options" + } + }, + "additionalProperties": false + }, + "relationships": { + "allOf": [ + { + "$ref": "../../tag_types.json#/definitions/relationships_description" + }, + { + "type": "object", + "properties": { + "triggers": { + "$ref": "../../tag_types.json#/definitions/trigger_relationship" + } + }, + "additionalProperties": false, + "required": [ + "triggers" + ] + } + ] + } + }, + "additionalProperties": false, + "required": [ + "id", + "type", + "attributes" + ] + } + }, + "additionalProperties": false, + "required": [ + "data" + ] +} diff --git a/tag_manager/authorized_api/src/tags/schema/edit/tags_edit_request_schema.json b/tag_manager/authorized_api/src/tags/schema/edit/tags_edit_request_schema.json index 34fe5cd5..32259e3f 100644 --- a/tag_manager/authorized_api/src/tags/schema/edit/tags_edit_request_schema.json +++ b/tag_manager/authorized_api/src/tags/schema/edit/tags_edit_request_schema.json @@ -126,6 +126,9 @@ }, { "$ref": "request/ecommerce_product_detail_view_edit.json" + }, + { + "$ref": "request/ecommerce_cart_update_edit.json" } ] } diff --git a/tag_manager/authorized_api/src/tags/schema/get/response/ecommerce_cart_update_get.json b/tag_manager/authorized_api/src/tags/schema/get/response/ecommerce_cart_update_get.json new file mode 100644 index 00000000..2a85b5f8 --- /dev/null +++ b/tag_manager/authorized_api/src/tags/schema/get/response/ecommerce_cart_update_get.json @@ -0,0 +1,114 @@ +{ + "title": "Ecommerce Cart update", + "description": "Ecommerce Cart update response", + "type": "object", + "properties": { + "data": { + "title": "JSON:API 1.0 response data", + "type": "object", + "properties": { + "id": { + "$ref": "../../tag_types.json#/definitions/tag_identifier" + }, + "type": { + "$ref": "../../tag_types.json#/definitions/tag_resource_type" + }, + "attributes": { + "description": "Ecommerce Cart update attributes", + "type": "object", + "properties": { + "disable_in_debug_mode": { + "$ref": "../../tag_attributes.json#/definitions/disable_in_debug_mode" + }, + "document_write": { + "$ref": "../../tag_attributes.json#/definitions/document_write" + }, + "is_active": { + "$ref": "../../tag_attributes.json#/definitions/is_active" + }, + "is_published": { + "$ref": "../../tag_attributes.json#/definitions/is_published" + }, + "priority": { + "$ref": "../../tag_attributes.json#/definitions/priority" + }, + "tag_type": { + "$ref": "../../tag_attributes.json#/definitions/tag_type_async" + }, + "name": { + "$ref": "../../tag_attributes.json#/definitions/name" + }, + "respect_visitors_privacy": { + "$ref": "../../tag_attributes.json#/definitions/respect_visitors_privacy" + }, + "scheduler": { + "$ref": "../../tag_attributes.json#/definitions/scheduler" + }, + "consent_type": { + "$ref": "../../tag_attributes.json#/definitions/consent_type" + }, + "template": { + "$ref": "../../tag_templates/ecommerce/ecommerce_cart_update_attributes.json#/definitions/template" + }, + "template_options": { + "$ref": "../../tag_templates/ecommerce/ecommerce_cart_update_attributes_get.json#/definitions/template_options" + }, + "created_at": { + "$ref": "../../../../common/schema/common_types.json#/definitions/datetime" + }, + "updated_at": { + "$ref": "../../../../common/schema/common_types.json#/definitions/datetime" + } + }, + "additionalProperties": false, + "required": [ + "disable_in_debug_mode", + "document_write", + "is_active", + "is_published", + "priority", + "tag_type", + "name", + "respect_visitors_privacy", + "scheduler", + "consent_type", + "template", + "template_options", + "created_at", + "updated_at" + ] + }, + "relationships": { + "allOf": [ + { + "$ref": "../../tag_types.json#/definitions/relationships_description" + }, + { + "type": "object", + "properties": { + "triggers": { + "$ref": "../../tag_types.json#/definitions/trigger_relationship" + } + }, + "additionalProperties": false, + "required": [ + "triggers" + ] + } + ] + } + }, + "additionalProperties": false, + "required": [ + "id", + "type", + "attributes", + "relationships" + ] + } + }, + "additionalProperties": false, + "required": [ + "data" + ] +} diff --git a/tag_manager/authorized_api/src/tags/schema/get/tags_get_response_schema.json b/tag_manager/authorized_api/src/tags/schema/get/tags_get_response_schema.json index 3d6086ac..d533158b 100644 --- a/tag_manager/authorized_api/src/tags/schema/get/tags_get_response_schema.json +++ b/tag_manager/authorized_api/src/tags/schema/get/tags_get_response_schema.json @@ -126,6 +126,9 @@ }, { "$ref": "response/ecommerce_product_detail_view_get.json" + }, + { + "$ref": "response/ecommerce_cart_update_get.json" } ] } diff --git a/tag_manager/authorized_api/src/tags/schema/tag_attributes.json b/tag_manager/authorized_api/src/tags/schema/tag_attributes.json index e07b0689..b0d68786 100644 --- a/tag_manager/authorized_api/src/tags/schema/tag_attributes.json +++ b/tag_manager/authorized_api/src/tags/schema/tag_attributes.json @@ -207,7 +207,8 @@ "ecommerce_order", "ecommerce_add_to_cart", "ecommerce_remove_from_cart", - "ecommerce_product_detail_view" + "ecommerce_product_detail_view", + "ecommerce_cart_update" ] }, "template_options_empty": { diff --git a/tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes.json b/tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes.json new file mode 100644 index 00000000..06cd35d3 --- /dev/null +++ b/tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes.json @@ -0,0 +1,45 @@ +{ + "definitions": { + "template": { + "$ref": "../../tag_attributes.json#/definitions/template", + "enum": [ + "ecommerce_cart_update" + ] + }, + "template_options": { + "type": "object", + "properties": { + "product_mapping": { + "$ref": "ecommerce_common_attributes.json#/definitions/product_mapping", + "description": "Product mapping" + }, + "category_mapping_type": { + "$ref": "ecommerce_common_attributes.json#/definitions/category_mapping_type" + }, + "category_mapping": { + "$ref": "ecommerce_common_attributes.json#/definitions/category_mapping" + }, + "products_array": { + "$ref": "ecommerce_common_attributes.json#/definitions/products_array" + }, + "grand_total": { + "type": "string", + "description": "Object key with grand total" + }, + "product_dimensions": { + "$ref": "ecommerce_common_attributes.json#/definitions/product_dimensions" + }, + "custom_dimensions": { + "$ref": "../piwik_base_attributes.json#/definitions/custom_dimensions" + } + }, + "additionalProperties": false, + "required": [ + "product_mapping", + "category_mapping_type", + "products_array", + "grand_total" + ] + } + } +} diff --git a/tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes_get.json b/tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes_get.json new file mode 100644 index 00000000..3220a99b --- /dev/null +++ b/tag_manager/authorized_api/src/tags/schema/tag_templates/ecommerce/ecommerce_cart_update_attributes_get.json @@ -0,0 +1,47 @@ +{ + "definitions": { + "template": { + "$ref": "../../tag_attributes.json#/definitions/template", + "enum": [ + "ecommerce_cart_update" + ] + }, + "template_options": { + "type": "object", + "properties": { + "product_mapping": { + "$ref": "ecommerce_common_attributes.json#/definitions/product_mapping", + "description": "Product mapping" + }, + "category_mapping_type": { + "$ref": "ecommerce_common_attributes.json#/definitions/category_mapping_type" + }, + "category_mapping": { + "$ref": "ecommerce_common_attributes.json#/definitions/category_mapping" + }, + "products_array": { + "$ref": "ecommerce_common_attributes.json#/definitions/products_array" + }, + "grand_total": { + "type": "string", + "description": "Object key with grand total" + }, + "product_dimensions": { + "$ref": "ecommerce_common_attributes.json#/definitions/product_dimensions" + }, + "custom_dimensions": { + "$ref": "../piwik_base_attributes.json#/definitions/custom_dimensions" + } + }, + "additionalProperties": false, + "required": [ + "product_mapping", + "category_mapping_type", + "products_array", + "grand_total", + "product_dimensions", + "custom_dimensions" + ] + } + } +} diff --git a/tag_manager/authorized_api/src/tags/schema/tag_templates/piwik_attributes.json b/tag_manager/authorized_api/src/tags/schema/tag_templates/piwik_attributes.json index 3f84b3d9..a4f4addd 100644 --- a/tag_manager/authorized_api/src/tags/schema/tag_templates/piwik_attributes.json +++ b/tag_manager/authorized_api/src/tags/schema/tag_templates/piwik_attributes.json @@ -141,8 +141,9 @@ ] }, "template_options_disable_cookies": { - "description": "Disables all first party cookies", - "type": "boolean" + "description": "Disables all first party cookies (is ignored and will be removed in next version). This setting is now reflected in privacyUseCookies attribute in App scope.", + "type": "boolean", + "deprecated": true }, "template_options_secure_cookie": { "description": "Enable secure cookie flag on all first party cookies. This should be used when your website is only available under HTTPS so that all tracking cookies are always sent over secure connection.",