Txgb: Most-used fields

Txgb: Most-used fields#

The table below gives information about most-used fields that you can import from Txgb. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Description

Use in Adverity

ad_campaign_code

Unique identifier for an advertising campaign associated with a booking.

dimension

ad_campaign_id

System-generated identifier for an advertising campaign.

dimension

ad_campaign_name

Descriptive name of the advertising campaign.

dimension

ad_campaign_slogan

Promotional phrase or motto used in the advertising campaign.

dimension

booking_date

The date when the booking was created or made.

dimension

booking_state

Current status of the booking, such as Confirmed, Cancelled, InError, or GeneralFailure.

dimension

booking_system_reference

A unique reference ID assigned to the booking by the booking system.

dimension

booking_type

Classification of the booking, such as Direct or OnAccount.

dimension

campaign_code

Unique code for a marketing campaign associated with the booking.

dimension

campaign_id

System-generated identifier for a marketing campaign.

dimension

campaign_name

Descriptive name of the marketing campaign.

dimension

campaign_promo_code

Promotional code used for a marketing campaign, often providing discounts.

dimension

campaign_slogan

Promotional phrase or motto used in the marketing campaign.

dimension

customer_address_line1

First line of the customer’s street address.

dimension

customer_address_line2

Second line of the customer’s street address, if applicable.

dimension

customer_city

City of the customer’s address.

dimension

customer_country

Country of the customer’s address.

dimension

customer_email

Customer’s primary email address.

dimension

customer_first_name

Customer’s given name.

dimension

customer_last_name

Customer’s family name.

dimension

customer_marketing_cross_emails

Indicates customer’s consent to receive cross-promotional marketing emails.

dimension

customer_marketing_periodic_emails

Indicates customer’s consent to receive periodic marketing emails (e.g., newsletters).

dimension

customer_postcode

Postcode or ZIP code of the customer’s address.

dimension

customer_special_requirements

Specific needs or requests made by the customer for their booking.

dimension

customer_state

State, province, or region of the customer’s address.

dimension

customer_telephone_home

Customer’s home telephone number.

dimension

customer_telephone_mobile

Customer’s mobile telephone number.

dimension

customer_telephone_work

Customer’s work telephone number.

dimension

distributor_address_line1

First line of the distributor’s street address.

dimension

distributor_address_line2

Second line of the distributor’s street address, if applicable.

dimension

distributor_city

City of the distributor’s address.

dimension

distributor_country

Country of the distributor’s address.

dimension

distributor_email

Distributor’s primary email address.

dimension

distributor_full_name

Full legal name of the distributor.

dimension

distributor_id

Unique identifier for the distributor.

dimension

distributor_postcode

Postcode or ZIP code of the distributor’s address.

dimension

distributor_short_name

Abbreviated or common name of the distributor.

dimension

distributor_state

State, province, or region of the distributor’s address.

dimension

distributor_tax_id

Tax identification number for the distributor.

dimension

distributor_telephone

Distributor’s primary telephone number.

dimension

industry_category

The category of the tourism product or service, such as Accommodation or Attraction.

dimension

merchant_address_line1

First line of the merchant’s street address.

dimension

merchant_address_line2

Second line of the merchant’s street address, if applicable.

dimension

merchant_city

City of the merchant’s address.

dimension

merchant_country

Country of the merchant’s address.

dimension

merchant_email

Merchant’s primary email address.

dimension

merchant_full_name

Full legal name of the merchant.

dimension

merchant_id

Unique identifier for the merchant.

dimension

merchant_postcode

Postcode or ZIP code of the merchant’s address.

dimension

merchant_short_name

Abbreviated or common name of the merchant.

dimension

merchant_state

State, province, or region of the merchant’s address.

dimension

merchant_tax_id

Tax identification number for the merchant.

dimension

merchant_telephone

Merchant’s primary telephone number.

dimension

num_adults

The number of adult participants included in the booking.

metric

num_children

The number of child participants included in the booking.

metric

num_concessions

The number of concession-eligible participants included in the booking.

metric

obx_reference

Reference ID for the booking within the Open Booking Exchange (OBX) system.

dimension

payment_method

The method used to pay for the booking (e.g., credit card, bank transfer).

dimension

product_cancelled

Boolean indicator showing if the booked product or service was cancelled.

dimension

product_commencing_date

The start date for the booked product or service.

dimension

product_concluding_date

The end date for the booked product or service.

dimension

product_id

Unique identifier for the booked product or service.

dimension

product_name

Name of the booked product or service.

dimension

product_quantity

The number of units of the product or service booked.

metric

product_refunded

Boolean indicator showing if the booked product or service was refunded.

dimension

provider_address_line1

First line of the provider’s street address.

dimension

provider_address_line2

Second line of the provider’s street address, if applicable.

dimension

provider_city

City of the provider’s address.

dimension

provider_country

Country of the provider’s address.

dimension

provider_email

Provider’s primary email address.

dimension

provider_full_name

Full legal name of the provider.

dimension

provider_id

Unique identifier for the provider.

dimension

provider_postcode

Postcode or ZIP code of the provider’s address.

dimension

provider_short_name

Abbreviated or common name of the provider.

dimension

provider_state

State, province, or region of the provider’s address.

dimension

provider_tax_id

Tax identification number for the provider.

dimension

provider_telephone

Provider’s primary telephone number.

dimension

reservation_id

A unique identifier for the specific reservation.

dimension

total_price

The total price of the booking, including all extras and taxes.

metric

total_price_excluding_extras

The total price of the booking, excluding any additional services or items.

metric

transaction_date

The date when the financial transaction for the booking occurred.

dimension