{"id":"3a6cffa8-c010-4989-b527-e8b87792cc01","createdDate":"2024-07-26T15:02:41.351Z","updatedDate":"2024-07-26T15:02:41.351Z","resourceId":"7eca55aa-1529-4110-a735-74114af0134e","api":{"schema":{"object":{"displayName":"Tag Object","description":"","slug":"tag-object","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","legacyExamples":[{"title":"MarketingTag","content":"{\n \"id\": \"cab0a9e1-b2aa-41b6-991a-9bd40ab15e62\",\n \"type\": \"FACEBOOK_PIXEL\",\n \"enabled\": true,\n \"facebook_pixel\": {\n \"domain\": \"some-domain.com\",\n \"tracking_id\": \"111111111111111\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/editor-server.git"},"methods":[{"summary":"List Marketing Tags","description":"Retrieves marketing tags given the provided filter.","operationId":"com.wixpress.marketing.tags.api.v1.MarketingTagsService.ListMarketingTags","parameters":[{"name":"filter","in":"query","description":"optional filter","required":false,"schema":{"description":"optional filter","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.ListMarketingTagsRequest.Filter","summary":"filter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.ListMarketingTagsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/marketing/v1","destinationPath":"/v1","url":"www.wixapis.com","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService"}},{"url":"https://www.wixapis.com/marketing/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/marketing/v2","destinationPath":"/v2","url":"www.wixapis.com","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MARKETING_TAGS.READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}],"protoArtifactId":"com.wixpress:marketing-tags-api","serviceArtifactId":"com.wixpress.editor.site.embeds.proxy.marketing-tags-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.marketing.tags.api.v1.ListMarketingTagsRequest","responseMessage":"com.wixpress.marketing.tags.api.v1.ListMarketingTagsResponse"},"legacyExamples":[{"name":"ListMarketingTags","type":"METHOD","content":{"title":"List Marketing Tags","request":"curl -X GET \\\n 'https://www.wixapis.com/marketing/v1/tags' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"tags\": [\n {\n \"id\": \"cab0a9e1-b2aa-41b6-991a-9bd40ab15e62\",\n \"type\": \"FACEBOOK_PIXEL\",\n \"enabled\": true,\n \"facebook_pixel\": {\n \"domain\": \"some-domain.com\",\n \"tracking_id\": \"111111111111111\"\n }\n },\n {\n \"id\": \"994ba324-682c-4d81-abd6-84e4be44ba3c\",\n \"type\": \"GOOGLE_ANALYTICS\",\n \"enabled\": true,\n \"google_analytics\": {\n \"domain\": \"some-domain.com\",\n \"tracking_id\": \"UA-12345678-1\",\n \"ip_anonymization\": false\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/editor-server.git"},"httpMethod":"get","path":"/v1/tags","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MARKETING_TAGS.READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}],"protoArtifactId":"com.wixpress:marketing-tags-api","serviceArtifactId":"com.wixpress.editor.site.embeds.proxy.marketing-tags-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.marketing.tags.api.v1.ListMarketingTagsRequest","responseMessage":"com.wixpress.marketing.tags.api.v1.ListMarketingTagsResponse"},"legacyExamples":[{"name":"ListMarketingTags","type":"METHOD","content":{"title":"List Marketing Tags","request":"curl -X GET \\\n 'https://www.wixapis.com/marketing/v1/tags' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"tags\": [\n {\n \"id\": \"cab0a9e1-b2aa-41b6-991a-9bd40ab15e62\",\n \"type\": \"FACEBOOK_PIXEL\",\n \"enabled\": true,\n \"facebook_pixel\": {\n \"domain\": \"some-domain.com\",\n \"tracking_id\": \"111111111111111\"\n }\n },\n {\n \"id\": \"994ba324-682c-4d81-abd6-84e4be44ba3c\",\n \"type\": \"GOOGLE_ANALYTICS\",\n \"enabled\": true,\n \"google_analytics\": {\n \"domain\": \"some-domain.com\",\n \"tracking_id\": \"UA-12345678-1\",\n \"ip_anonymization\": false\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/editor-server.git","contentLink":{"displayName":"List Marketing Tags","slugifiedName":"list-marketing-tags"},"permissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}],"isAdminMethod":true},{"summary":"Upsert Marketing Tag","description":"Creates or updates a marketing tag.","operationId":"com.wixpress.marketing.tags.api.v1.MarketingTagsService.UpsertMarketingTag","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.UpsertMarketingTagResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/marketing/v1","destinationPath":"/v1","url":"www.wixapis.com","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService"}},{"url":"https://www.wixapis.com/marketing/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/marketing/v2","destinationPath":"/v2","url":"www.wixapis.com","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpsertMarketingTagRequest","description":"","properties":{"tag":{"description":"Marketing tag to create or update.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["tag","tag.params"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Tag Created","description":"Triggered when a marketing tag is created.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.marketing.v1.tag_created","sourceRepo":"git@github.com:wix-private/editor-server.git"},{"title":"Tag Updated","description":"Triggered when a marketing tag is updated.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.marketing.v1.tag_updated","sourceRepo":"git@github.com:wix-private/editor-server.git"}],"serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MARKETING_TAGS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"}],"protoArtifactId":"com.wixpress:marketing-tags-api","serviceArtifactId":"com.wixpress.editor.site.embeds.proxy.marketing-tags-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.marketing.tags.api.v1.UpsertMarketingTagRequest","responseMessage":"com.wixpress.marketing.tags.api.v1.UpsertMarketingTagResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/editor-server.git"},"httpMethod":"post","path":"/v1/tags","rpcOnly":false,"triggeredEvents":[{"title":"Tag Created","description":"Triggered when a marketing tag is created.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.marketing.v1.tag_created","sourceRepo":"git@github.com:wix-private/editor-server.git"},{"title":"Tag Updated","description":"Triggered when a marketing tag is updated.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.marketing.v1.tag_updated","sourceRepo":"git@github.com:wix-private/editor-server.git"}],"serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MARKETING_TAGS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"}],"protoArtifactId":"com.wixpress:marketing-tags-api","serviceArtifactId":"com.wixpress.editor.site.embeds.proxy.marketing-tags-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.marketing.tags.api.v1.UpsertMarketingTagRequest","responseMessage":"com.wixpress.marketing.tags.api.v1.UpsertMarketingTagResponse"},"legacyExamples":[],"sourceRepo":"git@github.com:wix-private/editor-server.git","contentLink":{"displayName":"Upsert Marketing Tag","slugifiedName":"upsert-marketing-tag"},"permissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"}],"isAdminMethod":true},{"summary":"Delete Marketing Tag","description":"Deletes a marketing tag.","operationId":"com.wixpress.marketing.tags.api.v1.MarketingTagsService.DeleteMarketingTag","parameters":[{"name":"type","in":"query","description":"Marketing tag to delete.","required":false,"schema":{"description":"Marketing tag to delete.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.DeleteMarketingTagResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/marketing/v1","destinationPath":"/v1","url":"www.wixapis.com","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService"}},{"url":"https://www.wixapis.com/marketing/v2","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/marketing/v2","destinationPath":"/v2","url":"www.wixapis.com","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Tag Deleted","description":"Triggered when a marketing tag is deleted.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.marketing.v1.tag_deleted","sourceRepo":"git@github.com:wix-private/editor-server.git"}],"serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MARKETING_TAGS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"}],"protoArtifactId":"com.wixpress:marketing-tags-api","serviceArtifactId":"com.wixpress.editor.site.embeds.proxy.marketing-tags-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagRequest","responseMessage":"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagResponse"},"deprecated":{"message":"method is deprecated due to a problem occurred when using it via REST.","replacedBy":"DeleteMarketingTagV2","targetRemovalDate":"2022-10-01"},"legacyExamples":[{"name":"DeleteMarketingTag","type":"METHOD","content":{"title":"Delete Marketing Tag","request":"curl -X DELETE \\\n 'https://www.wixapis.com/marketing/v2/tags?tag_type=' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{"}}],"sourceRepo":"git@github.com:wix-private/editor-server.git"},"httpMethod":"delete","path":"/v1/tags","rpcOnly":false,"triggeredEvents":[{"title":"Tag Deleted","description":"Triggered when a marketing tag is deleted.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.marketing.v1.tag_deleted","sourceRepo":"git@github.com:wix-private/editor-server.git"}],"serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["MARKETING_TAGS.MANAGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"}],"protoArtifactId":"com.wixpress:marketing-tags-api","serviceArtifactId":"com.wixpress.editor.site.embeds.proxy.marketing-tags-proxy","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagRequest","responseMessage":"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagResponse"},"legacyExamples":[{"name":"DeleteMarketingTag","type":"METHOD","content":{"title":"Delete Marketing Tag","request":"curl -X DELETE \\\n 'https://www.wixapis.com/marketing/v2/tags?tag_type=' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\","response":"{"}}],"sourceRepo":"git@github.com:wix-private/editor-server.git","contentLink":{"displayName":"Delete Marketing Tag","slugifiedName":"delete-marketing-tag"},"deprecationDetails":{"message":"method is deprecated due to a problem occurred when using it via REST.","replacedBy":"DeleteMarketingTagV2","targetRemovalDate":"2022-10-01"},"permissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"}],"isAdminMethod":true}],"webhooks":[{"summary":"Marketing Tag Created","title":"Tag Created","description":"Triggered when a marketing tag is created.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}],"eventType":"wix.marketing.v1.tag_created","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/editor-server.git","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","contentLink":{"displayName":"Marketing Tag Created","slugifiedName":"marketing-tag-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}]},{"summary":"Marketing Tag Updated","title":"Tag Updated","description":"Triggered when a marketing tag is updated.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}],"eventType":"wix.marketing.v1.tag_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/editor-server.git","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","contentLink":{"displayName":"Marketing Tag Updated","slugifiedName":"marketing-tag-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}]},{"summary":"Marketing Tag Deleted","title":"Tag Deleted","description":"Triggered when a marketing tag is deleted.","permissions":["MARKETING_TAGS.READ"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.marketing.v1.tag","serviceName":"com.wixpress.marketing.tags.api.v1.MarketingTagsService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}],"eventType":"wix.marketing.v1.tag_deleted","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/editor-server.git","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","contentLink":{"displayName":"Marketing Tag Deleted","slugifiedName":"marketing-tag-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Marketing Tags","scopeId":"SCOPE.DC-MARKETING.MANAGE-TAGS"},{"name":"Read Marketing Tags","scopeId":"SCOPE.DC-MARKETING.READ-TAGS"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Marketing Tags\n\nWith Wix Marketing Tags, site owners can embed marketing tags in their website. The supported marketing tags are:\n\n* [**Google Ads Conversion tag**](fallback::https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091)\n\n > **Note:** The **Google Ads Conversion tag** was previously called **Google AdWords tag**.\n* [**Google Analytics tag**](fallback::https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579)\n\n\n > **Note:** Both [**Google Universal Analytics tags**](fallback::https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310) and [**Google Analytics 4 tags**](fallback::https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310) are supported.\n* [**Yandex Metrica tag**](fallback::https://yandex.com/support/metrica/index.html)\n* [**Facebook Pixel tag**](fallback::https://developers.facebook.com/docs/facebook-pixel/)\n* [**Google tag**](fallback::https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)\n\n\nThese marketing tags enable site owners to track user activity, ad conversion rates, and more.\n\n> **Note:** Only one marketing tag of each type is supported per Wix site.\n\n\nThe Marketing Tags APIs allow your app to:\n\n* List marketing tags\n* Create and update marketing tags\n* Delete marketing tags\n\n\n## Terminology\n\n* **Domain:** Specifies which website is associated with the marketing tag.\n\n > **Note:** When the site owner changes the domain of a Wix site, the embedded marketing tags won’t load anymore. To update the domain use the [Upsert Marketing Tag](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7eca55aa-1529-4110-a735-74114af0134eslug::upsert-marketing-tag*fallback::https://dev.wix.com/api/rest/marketing/marketing-tags/upsert-marketing-tag) endpoint. Currently, there is no way to sign up for notifications when a site owner changes their domain name.\n* **Tracking ID:** Specifies which external ID is associated with the site owner. Learn more about each tracking ID in the corresponding object description. These are the supported external IDs:\n\n | Marketing Tag | External ID Name | ID Format| \n |-|-|-|\n | Google Ads Conversion tag | Conversion ID | AW-123456789 |\n | Google Universal Analytics tag | Analytics ID | UA-12345-1 |\n | Google Analytics 4 tag | Measurement ID | G-12345 |\n | Yandex Metrica tag | Tag number | 123456789 |\n | Facebook Pixel tag | Pixel ID | 123456789 |\n | Google tag | Tag Manager Container ID | GTM-12345 |\n","sourceRepo":"git@github.com:wix-private/editor-server.git","path":"docs/intro.md"},{"displayName":"Example Flow","slugifyName":"example-flow","content":"# Example Flow: Wix Marketing Tags\n\nThis article shares a possible use case your app could support, as well as an example flow. You're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.\n\n\n## Manage Marketing Tags\n\nYour app could help site owners manage their marketing tags after they have updated their site structure. First, you’ll list the existing tags. Then your app will update the associated domains.\n\n\n### Step 1: List the Embedded Marketing Tags\n\nFirst, your app will call the [List Marketing Tags endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7eca55aa-1529-4110-a735-74114af0134eslug::list-marketing-tags*fallback::https://dev.wix.com/api/rest/marketing/marketing-tags/list-marketing-tags) to retrieve the marketing tags that the owners have previously embedded. \n\n```sh\ncurl -X GET \\\n https://www.wixapis.com/marketing/v1/tags \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n```\n\nIn the response of the call, you can see that the associated domains are out-dated, and thus the marketing tags won’t load anymore. \n\n\n```json\n{\"tags\": [\n {\n \"id\": \"994ba324-682c-4d81-abd6-84e4be44ba3c\",\n \"type\": \"GOOGLE_ADS\",\n \"enabled\": true,\n \"google_ads\": {\n \"domain\": \"old-domain.com\",\n \"tracking_id\": \"AW-672490861\"\n }\n },\n {\n \"id\": \"123ba321-678c-4d81-abd6-84e4be44ba3c\",\n \"type\": \"FACEBOOK_PIXEL\",\n \"enabled\": true,\n \"facebook_pixel\": {\n \"domain\": \"old-domain.com\",\n \"tracking_id\": \"123456789\"\n }\n }\n]}\n```\n\n\n\n### Step 2: Update an Embedded Marketing Tag\n\nThen, you’ll do a separate call of the [Upsert Marketing Tag endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7eca55aa-1529-4110-a735-74114af0134eslug::upsert-marketing-tag*fallback::https://dev.wix.com/api/rest/marketing/marketing-tags/upsert-marketing-tag) for each tag to change the associated domain. You’ll need to pass the new domain in the body of each call, as shown in the example below for the Google Ads Conversion tag.\n\n```sh\ncurl -X POST \\\n https://www.wixapis.com/marketing/v1/tags \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"tag\": {\n \"enabled\": true,\n \"google_ads\": {\n \"domain\": \"new-domain.com\",\n \"tracking_id\": \"AW-672490861\",\n }\n }\n }'\n```","sourceRepo":"git@github.com:wix-private/editor-server.git","path":"docs/Flow.md"}],"components":{"schemas":{"com.wixpress.marketing.tags.api.v1.MarketingTag":{"type":"object","properties":{"id":{"description":"Marketing tag ID.","readOnly":true,"format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"Marketing tag type.","readOnly":true,"title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"enabled":{"description":"Whether this tag is enabled.\nDefaults to `true`.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MarketingTag","description":"","oneOf":[{"description":"","summary":"params","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag.params"}]},"com.wixpress.marketing.tags.api.v1.MarketingTag.params":{"type":"object","title":"params","properties":{"googleAds":{"description":"A [Google Ads Conversion tag](https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091)\nlets site owners analyze what a visitor does after clicking on a Google ad.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.GoogleAds","summary":"googleAds","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"googleAnalytics":{"description":"A [Google Analytics tag](https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579)\nlets site owners track page views, where visitors are coming from, how long they stay, and\nwhat keywords they used to find the site. Both [Google Universal Analytics Tags](https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310)\nand [Google Analytics 4 tags](https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310)\nare supported.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.GoogleAnalytics","summary":"googleAnalytics","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"yandexMetrica":{"description":"A [Yandex Metrica tag](https://yandex.com/support/metrica/index.html) lets site\nowners build visual reports of visitor activity that helps them evaluate the\nperformance of their marketing campaigns.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.YandexMetrica","summary":"yandexMetrica","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"facebookPixel":{"description":"A [Facebook Pixel tag](https://developers.facebook.com/docs/facebook-pixel/)\nallows site owners to track Facebook ad-driven visitor activity on their site.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.FacebookPixel","summary":"facebookPixel","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"googleTagManager":{"description":"A [Google tag](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)\nlets site owners implement a quick and easy tag management system that keeps\n3rd party code snippets organized.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.GoogleTagManager","summary":"googleTagManager","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tikTokPixel":{"description":"A [TikTok Pixel](https://ads.tiktok.com/help/article?aid=9663)\nallows site owners to share visitor events to TikTok on their site.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.TikTokPixel","summary":"tikTokPixel","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"googleTagManagerConsentMode":{"description":"This consent mode tag uses [Google Tag Manager](https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530),\nwhich allows site owners to implement a quick and easy tag management system that keeps\n3rd party code snippets organized.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.GoogleTagManagerConsentMode","summary":"googleTagManagerConsentMode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"googleAnalyticsConsentMode":{"description":"This consent mode tag uses the [Google Tag API](https://developers.google.com/tag-platform/gtagjs/reference), which allows site owners to track:\n- Page views\n- Where visitors are coming from\n- How long visitors stay on the site\n- What keywords visitors used to find the site","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.GoogleAnalyticsConsentMode","summary":"googleAnalyticsConsentMode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.marketing.tags.api.v1.MarketingTag.Type":{"type":"string","description":"","title":"Type","enum":["UNKNOWN","GOOGLE_ADS","GOOGLE_ANALYTICS","YANDEX_METRICA","FACEBOOK_PIXEL","GOOGLE_TAG_MANAGER","TIKTOK_PIXEL","GOOGLE_TAG_MANAGER_CONSENT_MODE","GOOGLE_ANALYTICS_CONSENT_MODE"]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.marketing.tags.api.v1.GoogleAds":{"type":"object","properties":{"domain":{"description":"Domain associated with the Google Ads Conversion tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Conversion ID in AW-123456789 format.\nSpecifies which Google property is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GoogleAds","description":""},"com.wixpress.marketing.tags.api.v1.GoogleAnalytics":{"type":"object","properties":{"domain":{"description":"Domain associated with the Google Analytics tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Measurement ID for Google Analytics 4 tags in G-12345 format,\nor Analytics ID for Google Universal Analytics tags in UA-12345-1 format.\nSpecifies which Google property is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ipAnonymization":{"description":"Whether IP addresses of site visitors are hidden from Google.","title":"ipAnonymization","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GoogleAnalytics","description":""},"com.wixpress.marketing.tags.api.v1.YandexMetrica":{"type":"object","properties":{"domain":{"description":"Domain associated with the Yandex Metrica tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Yandex Tag Number in 123456789 format.\nSpecifies which Yandex tag is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"YandexMetrica","description":""},"com.wixpress.marketing.tags.api.v1.FacebookPixel":{"type":"object","properties":{"domain":{"description":"Domain associated with the Facebook Pixel tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Pixel ID in 123456789 format.\nSpecifies which Facebook Pixel is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FacebookPixel","description":""},"com.wixpress.marketing.tags.api.v1.GoogleTagManager":{"type":"object","properties":{"domain":{"description":"Domain associated with the Google tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Tag Manager Container ID in GTM-12345 format.\nSpecifies which Google Tag Manager Container is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GoogleTagManager","description":""},"com.wixpress.marketing.tags.api.v1.TikTokPixel":{"type":"object","properties":{"domain":{"description":"Domain associated with the TikTok Pixel.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Specifies which TikTok Pixel is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TikTokPixel","description":""},"com.wixpress.marketing.tags.api.v1.GoogleTagManagerConsentMode":{"type":"object","properties":{"domain":{"description":"Domain associated with the Google tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Tag Manager Container ID.\nSpecifies which Google Tag Manager Container is associated with the site owner.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GoogleTagManagerConsentMode","description":""},"com.wixpress.marketing.tags.api.v1.GoogleAnalyticsConsentMode":{"type":"object","properties":{"domain":{"description":"Domain associated with the Google Analytics tag.","format":"HOSTNAME","title":"domain","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trackingId":{"description":"Specifies which Google property is associated with the site owner.\nIt is either Measurement ID for [Google Analytics 4](https://developers.google.com/analytics/devguides/collection/ga4) tags in the `G-12345` format,\nor Analytics ID for Google Universal Analytics tags in the `UA-12345-1` format.","minLength":1,"maxLength":40,"title":"trackingId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ipAnonymization":{"description":"Whether the IP addresses of site visitors are hidden from Google.","title":"ipAnonymization","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GoogleAnalyticsConsentMode","description":""},"com.wixpress.live.site.data.htmlEmbedMessages.HtmlEmbedUpdateMessage":{"type":"object","properties":{"siteId":{"description":"Site's id","format":"GUID","title":"siteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HtmlEmbedUpdateMessage","description":""},"com.wixpress.marketing.tags.api.v1.UpsertMarketingTagRequest":{"type":"object","properties":{"tag":{"description":"Marketing tag to create or update.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpsertMarketingTagRequest","description":""},"com.wixpress.marketing.tags.api.v1.UpsertMarketingTagResponse":{"type":"object","properties":{"tag":{"description":"Created or updated marketing tag.","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpsertMarketingTagResponse","description":""},"com.wixpress.marketing.tags.api.v1.ListMarketingTagsRequest":{"type":"object","properties":{"filter":{"description":"optional filter","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.ListMarketingTagsRequest.Filter","summary":"filter","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListMarketingTagsRequest","description":""},"com.wixpress.marketing.tags.api.v1.ListMarketingTagsRequest.Filter":{"type":"object","properties":{"byType":{"description":"Filter by tag type.","title":"byType","type":"string","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Filter","description":"Information about which marketing tags to retrieve."},"com.wixpress.marketing.tags.api.v1.ListMarketingTagsResponse":{"type":"object","properties":{"tags":{"description":"List of marketing tags.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListMarketingTagsResponse","description":""},"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagRequest":{"type":"object","properties":{"type":{"description":"Marketing tag to delete.","title":"type","type":"string","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteMarketingTagRequest","description":""},"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagResponse":{"type":"object","properties":{},"title":"DeleteMarketingTagResponse","description":""},"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagV2Request":{"type":"object","properties":{"tagType":{"description":"Marketing tag to delete.","title":"tagType","type":"string","$ref":"#/components/schemas/com.wixpress.marketing.tags.api.v1.MarketingTag.Type","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteMarketingTagV2Request","description":""},"com.wixpress.marketing.tags.api.v1.DeleteMarketingTagV2Response":{"type":"object","properties":{},"title":"DeleteMarketingTagV2Response","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Tag","description":"","fqdn":"wix.marketing.v1.tag"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Marketing Tags\n\nWith Wix Marketing Tags, site owners can embed marketing tags in their website. The supported marketing tags are:\n\n* [**Google Ads Conversion tag**](fallback::https://support.google.com/tagmanager/answer/6105160?hl=en&ref_topic=6334091)\n\n > **Note:** The **Google Ads Conversion tag** was previously called **Google AdWords tag**.\n* [**Google Analytics tag**](fallback::https://support.google.com/tagmanager/topic/6333310?hl=en&ref_topic=3002579)\n\n\n > **Note:** Both [**Google Universal Analytics tags**](fallback::https://support.google.com/tagmanager/answer/6107124?hl=en&ref_topic=6333310) and [**Google Analytics 4 tags**](fallback::https://support.google.com/tagmanager/answer/9442095?hl=en&ref_topic=6333310) are supported.\n* [**Yandex Metrica tag**](fallback::https://yandex.com/support/metrica/index.html)\n* [**Facebook Pixel tag**](fallback::https://developers.facebook.com/docs/facebook-pixel/)\n* [**Google tag**](fallback::https://support.google.com/tagmanager/answer/6102821?hl=en&ref_topic=3441530)\n\n\nThese marketing tags enable site owners to track user activity, ad conversion rates, and more.\n\n> **Note:** Only one marketing tag of each type is supported per Wix site.\n\n\nThe Marketing Tags APIs allow your app to:\n\n* List marketing tags\n* Create and update marketing tags\n* Delete marketing tags\n\n\n## Terminology\n\n* **Domain:** Specifies which website is associated with the marketing tag.\n\n > **Note:** When the site owner changes the domain of a Wix site, the embedded marketing tags won’t load anymore. To update the domain use the [Upsert Marketing Tag](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7eca55aa-1529-4110-a735-74114af0134eslug::upsert-marketing-tag*fallback::https://dev.wix.com/api/rest/marketing/marketing-tags/upsert-marketing-tag) endpoint. Currently, there is no way to sign up for notifications when a site owner changes their domain name.\n* **Tracking ID:** Specifies which external ID is associated with the site owner. Learn more about each tracking ID in the corresponding object description. These are the supported external IDs:\n\n | Marketing Tag | External ID Name | ID Format| \n |-|-|-|\n | Google Ads Conversion tag | Conversion ID | AW-123456789 |\n | Google Universal Analytics tag | Analytics ID | UA-12345-1 |\n | Google Analytics 4 tag | Measurement ID | G-12345 |\n | Yandex Metrica tag | Tag number | 123456789 |\n | Facebook Pixel tag | Pixel ID | 123456789 |\n | Google tag | Tag Manager Container ID | GTM-12345 |\n"},{"displayName":"Example Flow","slugifyName":"example-flow","content":"# Example Flow: Wix Marketing Tags\n\nThis article shares a possible use case your app could support, as well as an example flow. You're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.\n\n\n## Manage Marketing Tags\n\nYour app could help site owners manage their marketing tags after they have updated their site structure. First, you’ll list the existing tags. Then your app will update the associated domains.\n\n\n### Step 1: List the Embedded Marketing Tags\n\nFirst, your app will call the [List Marketing Tags endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7eca55aa-1529-4110-a735-74114af0134eslug::list-marketing-tags*fallback::https://dev.wix.com/api/rest/marketing/marketing-tags/list-marketing-tags) to retrieve the marketing tags that the owners have previously embedded. \n\n```sh\ncurl -X GET \\\n https://www.wixapis.com/marketing/v1/tags \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n```\n\nIn the response of the call, you can see that the associated domains are out-dated, and thus the marketing tags won’t load anymore. \n\n\n```json\n{\"tags\": [\n {\n \"id\": \"994ba324-682c-4d81-abd6-84e4be44ba3c\",\n \"type\": \"GOOGLE_ADS\",\n \"enabled\": true,\n \"google_ads\": {\n \"domain\": \"old-domain.com\",\n \"tracking_id\": \"AW-672490861\"\n }\n },\n {\n \"id\": \"123ba321-678c-4d81-abd6-84e4be44ba3c\",\n \"type\": \"FACEBOOK_PIXEL\",\n \"enabled\": true,\n \"facebook_pixel\": {\n \"domain\": \"old-domain.com\",\n \"tracking_id\": \"123456789\"\n }\n }\n]}\n```\n\n\n\n### Step 2: Update an Embedded Marketing Tag\n\nThen, you’ll do a separate call of the [Upsert Marketing Tag endpoint](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::7eca55aa-1529-4110-a735-74114af0134eslug::upsert-marketing-tag*fallback::https://dev.wix.com/api/rest/marketing/marketing-tags/upsert-marketing-tag) for each tag to change the associated domain. You’ll need to pass the new domain in the body of each call, as shown in the example below for the Google Ads Conversion tag.\n\n```sh\ncurl -X POST \\\n https://www.wixapis.com/marketing/v1/tags \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"tag\": {\n \"enabled\": true,\n \"google_ads\": {\n \"domain\": \"new-domain.com\",\n \"tracking_id\": \"AW-672490861\",\n }\n }\n }'\n```"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}