- Created by Sylvain Paillard, last modified on Oct 22, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 13 Next »
Content: Vouchers / Coupons
Vouchers for customers
Overview
In this Data Type, you can define all the data about customer vouchers or coupons.
Example
In this example, we provide a simple attribute definition.
Here is the example for the first case above (make sure to format it in JSONL before loading to BigQuery: Newline delimited JSON : https://en.wikipedia.org/wiki/JSON_streaming).
{ "internal_id": "1234", "type": "product_specific", "voucher_products": [ { "sku": "123" }, { "sku": "456" } ], "title": [ { "language": "en", "value": "20% voucher on 2 cool products" } ], "pricing": [ { "customer_groups": [ "new_customer" ], "voucher_percentage_value": [ { "value": "0.2" } ] } ], "creation_tm": "2020-10-20 00:00:00", "client_id": 1, "src_sys_id": 1 }
Properties
Field name | Type | Mode | Description |
---|---|---|---|
internal_id | STRING | REQUIRED | the internal identifier of the voucher |
external_id | STRING | NULLABLE | the external identifier of the voucher (can be the same as the internal identifier) |
voucher_products | REPEATED | products related to the voucher | |
voucher_products_attributes | RECORD | REPEATED | product segments related to the voucher |
voucher_products_attributes. operator | STRING | NULLABLE | |
voucher_products_attributes. segments | RECORD | REPEATED | |
voucher_products_attributes.segments. type | STRING | NULLABLE | |
voucher_products_attributes.segments. name | STRING | NULLABLE | |
voucher_products_attributes.segments. value | STRING | NULLABLE | |
type | STRING | NULLABLE | the type value) |
ean | STRING | NULLABLE | the ean value) |
label | STRING | NULLABLE | label of the voucher |
creation | DATETIME | NULLABLE | |
last_update | DATETIME | NULLABLE | |
is_new | BOOLEAN | NULLABLE | |
in_sales | BOOLEAN | NULLABLE | |
product_relations | REPEATED | relations to other products | |
other_relations | REPEATED | relations to other contents | |
stores | STRING | REPEATED | the stores |
title | REPEATED | the title of the attribute value | |
short_description | REPEATED | the short description of the product group | |
description | REPEATED | the description of the attribute value | |
images | REPEATED | the images of the attribute value | |
link | REPEATED | the link of the attribute value | |
tags | REPEATED | the tags , e.g.: [STRUCT('tag', 'hello world', [STRUCT('de', 'hello world')])] | |
labels | REPEATED | the labels of the product line, e.g.: [STRUCT('symbol', 'delivery', '24h', [STRUCT('de', '24-H Versand')])] | |
pricing | REPEATED | ||
pricing. voucher_percentage_value | RECORD | REPEATED | the percentage value of the voucher |
pricing.voucher_percentage_value. language | STRING | REQUIRED | |
pricing.voucher_percentage_value. value | STRING | REQUIRED | |
pricing.voucher_percentage_value. currency | STRING | REQUIRED | |
pricing. voucher_absolute_value | RECORD | REPEATED | the absolute value of the voucher |
pricing.voucher_absolute_value. language | STRING | REQUIRED | |
pricing.voucher_absolute_value. value | STRING | REQUIRED | |
pricing.voucher_absolute_value. currency | STRING | REQUIRED | |
periods | REPEATED | information about the activity periods of the ugc | |
stock | REPEATED | the stock | |
visibility | REPEATED | the product visibility :VISIBILITY_NOT_VISIBLE = 1; VISIBILITY_IN_CATALOG = 2; VISIBILITY_IN_SEARCH = 3; VISIBILITY_BOTH = 4; | |
status | REPEATED | the product status | |
string_attributes | REPEATED | additional string (not localized) attributes of the product line | |
localized_string_attributes | REPEATED | additional localized string attributes | |
numeric_attributes | REPEATED | additional numeric (not localized) attributes | |
localized_numeric_attributes | REPEATED | additional localized numeric attributes | |
datetime_attributes | REPEATED | additional datetime (not localized) attributes | |
localized_datetime_attributes | REPEATED | additional localized datetime attributes | |
creation_tm | DATETIME | REQUIRED | technical field |
client_id | INTEGER | REQUIRED | technical field |
src_sys_id | INTEGER | REQUIRED | technical field |
Table structure
[ { "description": "the internal identifier of the voucher", "type": "STRING", "name": "internal_id", "mode": "REQUIRED" }, { "type": "STRING", "name": "external_id", "description": "the external identifier of the voucher (can be the same as the internal identifier)" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name" }, { "type": "STRING", "name": "product_line" }, { "type": "STRING", "name": "product_group" }, { "type": "STRING", "name": "sku" }, { "type": "STRING", "name": "voucher" }, { "type": "NUMERIC", "name": "value" } ], "description": "products related to the voucher", "type": "RECORD", "name": "voucher_products", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "operator" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name" }, { "type": "STRING", "name": "value" } ], "type": "RECORD", "name": "segments", "mode": "REPEATED" } ], "description": "product segments related to the voucher", "type": "RECORD", "name": "voucher_products_attributes", "mode": "REPEATED" }, { "type": "STRING", "name": "type", "description": "the type value)" }, { "type": "STRING", "name": "ean", "description": "the ean value)" }, { "type": "STRING", "name": "label", "description": "label of the voucher" }, { "type": "DATETIME", "name": "creation" }, { "type": "DATETIME", "name": "last_update" }, { "type": "BOOLEAN", "name": "is_new" }, { "type": "BOOLEAN", "name": "in_sales" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name" }, { "type": "STRING", "name": "product_line" }, { "type": "STRING", "name": "product_group" }, { "type": "STRING", "name": "sku" }, { "type": "STRING", "name": "voucher" }, { "type": "NUMERIC", "name": "value" } ], "description": "relations to other products", "type": "RECORD", "name": "product_relations", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name" }, { "type": "STRING", "name": "content_type" }, { "type": "STRING", "name": "content_id" }, { "type": "NUMERIC", "name": "value" } ], "description": "relations to other contents", "type": "RECORD", "name": "other_relations", "mode": "REPEATED" }, { "description": "the stores", "type": "STRING", "name": "stores", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "description": "the title of the voucher", "type": "RECORD", "name": "title", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "description": "the short description of the voucher", "type": "RECORD", "name": "short_description", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "description": "the description of the voucher", "type": "RECORD", "name": "description", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "name" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "value", "mode": "REPEATED" } ], "description": "the images of the voucher", "type": "RECORD", "name": "images", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "value", "mode": "REPEATED" } ], "description": "the brands of the voucher", "type": "RECORD", "name": "brands", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "value", "mode": "REPEATED" } ], "description": "the suppliers of the voucher", "type": "RECORD", "name": "suppliers", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "categorization", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "category_ids", "mode": "REPEATED" } ], "description": "the categories of the voucher", "type": "RECORD", "name": "categories", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "description": "the link of the voucher", "type": "RECORD", "name": "link", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "loc_values", "mode": "REPEATED" } ], "description": "the tags of the product line, e.g.: [STRUCT('tag', 'hello world', [STRUCT('de', 'hello world')])]", "type": "RECORD", "name": "tags", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type", "mode": "REQUIRED" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "loc_values", "mode": "REPEATED" } ], "description": "the labels of the voucher, e.g.: [STRUCT('symbol', 'delivery', '24h', [STRUCT('de', '24-H Versand')])]", "type": "RECORD", "name": "labels", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "customer_groups", "mode": "REPEATED" }, { "fields": [ { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "DATETIME", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "start_datetime", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "DATETIME", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "end_datetime", "mode": "REPEATED" } ], "type": "RECORD", "name": "periods", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "type": "STRING", "name": "currency", "mode": "REQUIRED" } ], "description": "price before any discount", "type": "RECORD", "name": "list_price", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "type": "STRING", "name": "currency", "mode": "REQUIRED" } ], "description": "price displayed to the customer after discounts", "type": "RECORD", "name": "sales_price", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "type": "STRING", "name": "currency", "mode": "REQUIRED" } ], "description": "price before any discount", "type": "RECORD", "name": "voucher_percentage_value", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "type": "STRING", "name": "currency", "mode": "REQUIRED" } ], "description": "price before any discount", "type": "RECORD", "name": "voucher_absolute_value", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" }, { "type": "STRING", "name": "currency", "mode": "REQUIRED" } ], "description": "the sales gross margin as an absolute value", "type": "RECORD", "name": "gross_margin", "mode": "REPEATED" } ], "type": "RECORD", "name": "pricing", "mode": "REPEATED" }, { "fields": [ { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "DATETIME", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "start_datetime", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "DATETIME", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "end_datetime", "mode": "REPEATED" } ], "description": "information about the activity periods of the voucher", "type": "RECORD", "name": "periods", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "availability" }, { "type": "STRING", "name": "delivery_center" }, { "type": "INTEGER", "name": "value" } ], "description": "the current stock", "type": "RECORD", "name": "stock", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "customer_groups", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "INTEGER", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "values", "mode": "REPEATED" } ], "description": "the product visibility :VISIBILITY_NOT_VISIBLE = 1; VISIBILITY_IN_CATALOG = 2; VISIBILITY_IN_SEARCH = 3; VISIBILITY_BOTH = 4;", "type": "RECORD", "name": "visibility", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "INTEGER", "name": "value", "mode": "REQUIRED" } ], "description": "the product status", "type": "RECORD", "name": "status", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "type": "STRING", "name": "values", "mode": "REPEATED" } ], "description": "additional string (not localized) attributes of the voucher", "type": "RECORD", "name": "string_attributes", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "STRING", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "values", "mode": "REPEATED" } ], "description": "additional localized string attributes of the voucher", "type": "RECORD", "name": "localized_string_attributes", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "type": "NUMERIC", "name": "values", "mode": "REPEATED" } ], "description": "additional numeric (not localized) attributes of the voucher", "type": "RECORD", "name": "numeric_attributes", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "NUMERIC", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "values", "mode": "REPEATED" } ], "description": "additional localized numeric attributes of the voucher", "type": "RECORD", "name": "localized_numeric_attributes", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "type": "DATETIME", "name": "values", "mode": "REPEATED" } ], "description": "additional datetime (not localized) attributes of the voucher", "type": "RECORD", "name": "datetime_attributes", "mode": "REPEATED" }, { "fields": [ { "type": "STRING", "name": "type" }, { "type": "STRING", "name": "name", "mode": "REQUIRED" }, { "fields": [ { "type": "STRING", "name": "language", "mode": "REQUIRED" }, { "type": "DATETIME", "name": "value", "mode": "REQUIRED" } ], "type": "RECORD", "name": "values", "mode": "REPEATED" } ], "description": "additional localized datetime attributes of the voucher", "type": "RECORD", "name": "localized_datetime_attributes", "mode": "REPEATED" }, { "description": "technical field", "type": "DATETIME", "name": "creation_tm", "mode": "REQUIRED" }, { "description": "technical field", "type": "INTEGER", "name": "client_id", "mode": "REQUIRED" }, { "description": "technical field", "type": "INTEGER", "name": "src_sys_id", "mode": "REQUIRED" } ]
CREATE OR REPLACE TABLE `YOUR_PROJECT.YOUR_DATASET.doc_voucher_F_20201030` ( internal_id STRING NOT NULL OPTIONS(description="the internal identifier of the voucher") , external_id STRING OPTIONS(description="the external identifier of the voucher (can be the same as the internal identifier)") , voucher_products ARRAY<STRUCT<type STRING, name STRING, product_line STRING, product_group STRING, sku STRING, voucher STRING, value NUMERIC>> OPTIONS(description="products related to the voucher") , voucher_products_attributes ARRAY<STRUCT<operator STRING, segments ARRAY<STRUCT<type STRING, name STRING, value STRING>>>> OPTIONS(description="product segments related to the voucher") , type STRING OPTIONS(description="the type value)") , ean STRING OPTIONS(description="the ean value)") , label STRING OPTIONS(description="label of the voucher") , creation DATETIME , last_update DATETIME , is_new BOOLEAN , in_sales BOOLEAN , product_relations ARRAY<STRUCT<type STRING, name STRING, product_line STRING, product_group STRING, sku STRING, voucher STRING, value NUMERIC>> OPTIONS(description="relations to other products") , other_relations ARRAY<STRUCT<type STRING, name STRING, content_type STRING, content_id STRING, value NUMERIC>> OPTIONS(description="relations to other contents") , stores ARRAY<STRING> OPTIONS(description="the stores") , title ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>> OPTIONS(description="the title of the voucher") , short_description ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>> OPTIONS(description="the short description of the voucher") , description ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>> OPTIONS(description="the description of the voucher") , images ARRAY<STRUCT<name STRING, value ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="the images of the voucher") , brands ARRAY<STRUCT<name STRING NOT NULL, value ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="the brands of the voucher") , suppliers ARRAY<STRUCT<name STRING NOT NULL, value ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="the suppliers of the voucher") , categories ARRAY<STRUCT<categorization STRING NOT NULL, category_ids ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="the categories of the voucher") , link ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>> OPTIONS(description="the link of the voucher") , tags ARRAY<STRUCT<type STRING NOT NULL, value STRING NOT NULL, loc_values ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="the tags of the product line, e.g.: [STRUCT('tag', 'hello world', [STRUCT('de', 'hello world')])]") , labels ARRAY<STRUCT<type STRING NOT NULL, name STRING NOT NULL, value STRING NOT NULL, loc_values ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="the labels of the voucher, e.g.: [STRUCT('symbol', 'delivery', '24h', [STRUCT('de', '24-H Versand')])]") , pricing ARRAY<STRUCT< customer_groups ARRAY<STRING NOT NULL> , periods ARRAY<STRUCT<start_datetime ARRAY<STRUCT<language STRING NOT NULL, value DATETIME NOT NULL>>, end_datetime ARRAY<STRUCT<language STRING NOT NULL, value DATETIME NOT NULL>>>> , list_price ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL, currency STRING NOT NULL>> OPTIONS(description="price before any discount") , sales_price ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL, currency STRING NOT NULL>> OPTIONS(description="price displayed to the customer after discounts") , voucher_percentage_value ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL, currency STRING NOT NULL>> OPTIONS(description="price before any discount") , voucher_absolute_value ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL, currency STRING NOT NULL>> OPTIONS(description="price before any discount") , gross_margin ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL, currency STRING NOT NULL>> OPTIONS(description="the sales gross margin as an absolute value") >> , periods ARRAY<STRUCT<start_datetime ARRAY<STRUCT<language STRING NOT NULL, value DATETIME NOT NULL>>, end_datetime ARRAY<STRUCT<language STRING NOT NULL, value DATETIME NOT NULL>>>> OPTIONS(description="information about the activity periods of the voucher") , stock ARRAY<STRUCT<availability STRING, delivery_center STRING, value INT64>> OPTIONS(description="the current stock") , visibility ARRAY<STRUCT<customer_groups ARRAY<STRING NOT NULL>, values ARRAY<STRUCT<language STRING NOT NULL, value INT64 NOT NULL>>>> OPTIONS(description="the product visibility :VISIBILITY_NOT_VISIBLE = 1; VISIBILITY_IN_CATALOG = 2; VISIBILITY_IN_SEARCH = 3; VISIBILITY_BOTH = 4;") , status ARRAY<STRUCT<language STRING NOT NULL, value INT64 NOT NULL>> OPTIONS(description="the product status") , string_attributes ARRAY<STRUCT<type STRING, name STRING NOT NULL, values ARRAY<STRING NOT NULL>>> OPTIONS(description="additional string (not localized) attributes of the voucher") , localized_string_attributes ARRAY<STRUCT<type STRING, name STRING NOT NULL, values ARRAY<STRUCT<language STRING NOT NULL, value STRING NOT NULL>>>> OPTIONS(description="additional localized string attributes of the voucher") , numeric_attributes ARRAY<STRUCT<type STRING, name STRING NOT NULL, values ARRAY<NUMERIC NOT NULL>>> OPTIONS(description="additional numeric (not localized) attributes of the voucher") , localized_numeric_attributes ARRAY<STRUCT<type STRING, name STRING NOT NULL, values ARRAY<STRUCT<language STRING NOT NULL, value NUMERIC NOT NULL>>>> OPTIONS(description="additional localized numeric attributes of the voucher") , datetime_attributes ARRAY<STRUCT<type STRING, name STRING NOT NULL, values ARRAY<DATETIME NOT NULL>>> OPTIONS(description="additional datetime (not localized) attributes of the voucher") , localized_datetime_attributes ARRAY<STRUCT<type STRING, name STRING NOT NULL, values ARRAY<STRUCT<language STRING NOT NULL, value DATETIME NOT NULL>>>> OPTIONS(description="additional localized datetime attributes of the voucher") , creation_tm DATETIME NOT NULL OPTIONS(description="technical field") , client_id INT64 NOT NULL OPTIONS(description="technical field") , src_sys_id INT64 NOT NULL OPTIONS(description="technical field") ) OPTIONS(description="The languages of the data (must match the ");
- No labels
Add Comment