new(guides): VTEX Ads docs migration - part II #2227
There are no files selected for viewing
|
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -79,7 +79,7 @@ You can manually modify the price when: | |||||||
|
|
||||||||
| Read the following sections for details on the endpoints you must use and their request body examples. | ||||||||
|
|
||||||||
| > ⚠️ You can only apply a manual price to a subscription item if the `manualPriceAllowed` configuration is set to `true`, as described in the [Configuration](#configuration) section. | ||||||||
|
|
||||||||
|
|
||||||||
|
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶 |
||||||||
| ### Adding an item to a subscription | ||||||||
|
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Comment on lines
84
to
85
Contributor
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||||
|
|
||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,7 +11,7 @@ Inventory information defines the price, promotional price, and "stock." Regardi | |||||
|
|
||||||
| Learn more about each field on `POST` [Synchronize inventory information](https://developers.vtex.com/docs/api-reference/vtex-ads-api#post-/product/bulk/inventories). | ||||||
|
|
||||||
| > ⚠️ Batch Insert / Update | ||||||
| > | ||||||
|
Contributor
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||
| > For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed. | ||||||
| > | ||||||
|
Contributor
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -15,7 +15,7 @@ Learn more about each field on `POST` [Synchronize product information](https:// | |||||
|
|
||||||
| To update the basic product data, the following endpoint must be used: | ||||||
|
|
||||||
| > ⚠️ Batch Insert / Update | ||||||
| > | ||||||
|
Contributor
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||
| > For each batch insert/update, a maximum of 500 objects per request and 3 simultaneous requests are allowed. | ||||||
| > | ||||||
|
Contributor
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,107 @@ | ||||||
| --- | ||||||
| title: "Exporting ads events" | ||||||
| slug: "exporting-ads-events" | ||||||
| excerpt: "Export raw advertising event data including impressions, clicks, views, and conversions for detailed analysis." | ||||||
| hidden: false | ||||||
| createdAt: "2025-10-13T00:00:00.000Z" | ||||||
| updatedAt: "2025-10-14T00:00:00.000Z" | ||||||
| --- | ||||||
| Event data export enables systematic and periodic integration of raw advertising events for detailed analysis and custom reporting. | ||||||
|
|
||||||
| ## Integration connection | ||||||
|
|
||||||
| See more about the connection in [Exporting data from VTEX Ads](https://developers.vtex.com/docs/guides/exporting-data-from-vtex-ads). | ||||||
|
Contributor
There was a problem hiding this comment. [link-check] reported by reviewdog 🐶 👉 Please review this link before merging your Pull Request. |
||||||
|
|
||||||
| ## Integration format | ||||||
|
|
||||||
| - Data sent is always D-1 (previous day) | ||||||
| - Files are in [Parquet](https://parquet.apache.org/docs/overview/) format with [Snappy](https://parquet.apache.org/docs/file-format/data-pages/compression/) compression | ||||||
| - Files are always sent in a daily path format: `TYPE_REPORT/YYYY/MM/DD/TIMESTAMP_NS/RANDOM_FILE_NAMES.snappy.parquet` (one or more files may be sent) | ||||||
|
|
||||||
| > ⚠️ Event deduplication | ||||||
| > | ||||||
|
Contributor
There was a problem hiding this comment. [markdownlint] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. [markdownlint-fix] reported by reviewdog 🐶
Suggested change
|
||||||
| > All events are guaranteed to be sent, but there is no guarantee that an event will be sent only once. Therefore, events must always be deduplicated. | ||||||
|
|
||||||
| ## Event data | ||||||
|
|
||||||
| ### Impressions | ||||||
|
|
||||||
| | Attribute | Type | Description | | ||||||
| | :------------- | :------------ | :-------------------------------------------------------------- | | ||||||
| | event_id | String | Unique event identifier **(deduplication key)** | | ||||||
| | session_id | String | Unique user session identifier | | ||||||
| | user_id | String | Unique user identifier | | ||||||
| | ad_id | String | Advertisement identifier | | ||||||
| | campaign_id | String | Unique campaign identifier | | ||||||
| | request_id | String | Unique ad query request identifier | | ||||||
| | ad_type | String | Type of advertisement that generated the event | | ||||||
| | placement_name | String | Name of the placement where the ad was displayed | | ||||||
| | context | String | Context in which the ad was displayed | | ||||||
| | created_at | Timestamp UTC | Timestamp of when the event occurred | | ||||||
| | site | String | Site brand identifier | | ||||||
|
|
||||||
| ### Views | ||||||
|
|
||||||
| | Attribute | Type | Description | | ||||||
| | :------------- | :------------ | :-------------------------------------------------------------- | | ||||||
| | event_id | String | Unique event identifier **(deduplication key)** | | ||||||
| | session_id | String | Unique user session identifier | | ||||||
| | user_id | String | Unique user identifier | | ||||||
| | ad_id | String | Advertisement identifier | | ||||||
| | campaign_id | String | Unique campaign identifier | | ||||||
| | request_id | String | Unique ad query request identifier | | ||||||
| | ad_type | String | Type of advertisement that generated the event | | ||||||
| | placement_name | String | Name of the placement where the ad was displayed | | ||||||
| | context | String | Context in which the ad was displayed | | ||||||
| | created_at | Timestamp UTC | Timestamp of when the event occurred | | ||||||
| | site | String | Site brand identifier | | ||||||
|
|
||||||
| ### Clicks | ||||||
|
|
||||||
| | Attribute | Type | Description | | ||||||
| | :------------- | :------------ | :-------------------------------------------------------------- | | ||||||
| | event_id | String | Unique event identifier **(deduplication key)** | | ||||||
| | session_id | String | Unique user session identifier | | ||||||
| | user_id | String | Unique user identifier | | ||||||
| | ad_id | String | Advertisement identifier | | ||||||
| | campaign_id | String | Unique campaign identifier | | ||||||
| | request_id | String | Unique ad query request identifier | | ||||||
| | ad_type | String | Type of advertisement that generated the event | | ||||||
| | placement_name | String | Name of the placement where the ad was displayed | | ||||||
| | context | String | Context in which the ad was displayed | | ||||||
| | created_at | Timestamp UTC | Timestamp of when the event occurred | | ||||||
| | site | String | Site brand identifier | | ||||||
|
|
||||||
| ### Conversions | ||||||
|
|
||||||
| | Attribute | Type | Description | | ||||||
| | :--------- | :------------ | :----------------------------------------------------- | | ||||||
| | event_id | String | Unique conversion event identifier | | ||||||
| | session_id | String | Unique user session identifier | | ||||||
| | user_id | String | Unique user identifier | | ||||||
| | order_id | String | Unique retail order identifier **(deduplication key)** | | ||||||
| | channel | String | Channel identifier | | ||||||
| | placed_at | Timestamp UTC | Order timestamp | | ||||||
| | site | String | Site brand identifier | | ||||||
|
|
||||||
| ### Conversion items | ||||||
|
|
||||||
| | Attribute | Type | Description | | ||||||
| | :---------------- | :-------- | :-------------------------------------------------------------- | | ||||||
| | event_id | String | Unique identifier of the event that generated the conversion (view or click) | | ||||||
| | session_id | String | Unique user session identifier | | ||||||
| | user_id | String | Unique user identifier | | ||||||
| | order_id | String | Unique retail order identifier **(deduplication key)** | | ||||||
| | product_sku | String | Product identifier **(deduplication key)** | | ||||||
| | ad_id | String | Unique advertisement identifier | | ||||||
| | campaign_id | String | Unique campaign identifier | | ||||||
| | request_id | String | Unique ad query request identifier | | ||||||
| | ad_size | String | Size of the media used in the advertisement | | ||||||
| | ad_type | String | Type of advertisement that generated the conversion | | ||||||
| | placement_name | String | Name of the placement where the ad was displayed | | ||||||
| | context | String | Context in which the ad was displayed | | ||||||
| | event_created_at | Timestamp | Timestamp of when the event occurred | | ||||||
| | price | Float | Product price (regular) | | ||||||
| | promotional_price | Float | Product promotional price | | ||||||
| | quantity | Int | Quantity of items sold | | ||||||
| | total_value | Float | Total item value (quantity * min(price, promotional_price)) | | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[markdownlint] reported by reviewdog 🐶
MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
dev-portal-content/docs/guides/Subscriptions/enabling-manual-prices-for-subscriptions-v3.md
Line 19 in 0e43567