Send feedback on this topic

Creating Containers

Oracle Data Cloud platform containers help you to do the following:

The site ID enables the platform to recognize incoming data as yours and the data extracted from your site to be mapped to the appropriate categories in your taxonomy via classification rules.

Important: Use a separate site ID for each of your desktop sites, mobile sites, and mobile apps. If you are collecting data from all three, you will need at least two containers: one for your desktop and mobile site, and another for your mobile app. Each mobile app should have its own container.

In this topic

Creating a container

You can create a container and generate tag code using the container creation tool. The tool includes different tag types that control how the container is fired and how it collects and transfers user data.

To create a container:

  1. Select Manage > Containers. The Containers page lists all the containers you have created.
    Containers page
    You can open a container to view its client-side tag code for use in to your website.
  2. Click Create New. The Create New Container dialog is displayed.
    Create New Container dialog
  3. In the Create New Container dialog, enter the following properties:
    PropertyDescription
    NameEnter a unique, descriptive name for the container that makes it easy to identify. For example, you can enter the name of your web site.
    List Type

    Whitelist (enable) or blacklist (disable) data collection for users with IP addresses mapped to the countries selected in the Country List.

    You can use whitelisting to enable data collection/delivery for a small set of countries (all unselected countries are disabled). You can use blacklisting to disable a small set of countries. Netherlands is blacklisted by default.

    Data Providers Onboarding EU Data. To ingest data for user profiles located in the European Union (EU), you must have signed Oracle's General Data Protection Regulation (GDPR) Consent agreement. If you have not signed the agreement, you can only create containers that are configured for non-EU countries.

    This means that a blacklist must include the EU region or countries and a whitelist may not; otherwise, the Containers dialog will display an error. By default, new containers will blacklist the EU.

    Contact your Oracle Account Representative to obtain and sign the agreement. After the agreement has been processed, you can edit your existing containers or create new ones for onboarding EU data.

    IP Address - Country Mapping:  Oracle uses third parties to map IP addresses to countries and is not responsible for the accuracy of those mappings. Customer is responsible for obtaining the consents from and providing the notices to all users whose data is collected through the services.

    Country List

    Select one or more countries or regions to be whitelisted or blacklisted based on the selected List Type. You can select all the countries in the EU by selecting the EU region.

    Default auction limitEnter the maximum number of slots available in the container for firing image tags. For DMP clients, this is the number of slots available for transferring first-party data to app partners. For data providers, this is the number of slots available for selling data or executing ID swaps. The default auction limit is 4. You can overwrite this default auction limit in your client-side container tag code. To do this, enter the overriding limit in the Pixel Limit per pageview property within the container tag code generator. The lowest value entered between the Create New Container dialog and the code generator will be the auction limit that is used.
    Data transfer enabledEnables the user data collected from this container to be sold to any partner in the Oracle Data Marketplace. This check box is cleared by default, which means that the data is private and cannot be sold to any partner that has not been whitelisted. You can classify your private data into public categories (for example, Geographic > Self Declared), and only you will get the data delivery or see the inventory.
    Performance pixelMakes this container a performance pixel, which is used only for analytics. This check box is cleared by default.
    Campaign accessSpecify which of your whitelisted partners can fire image pixels in the container's exchange <div> tag and win on this site:
    • Anyone: All of your whitelisted partners can win on this site. This is the recommended setting for data providers who sell data in the Oracle Data Marketplace.
    • Only Selected Partners: Only specified whitelisted partners can win on this site. To enable a whitelisted partner to win on your site, click anywhere in the box below and then select the partner. This is the recommended setting for DMP clients who work with a trading desk and need to give them access to their container.
    • Only Me: Only you can win on this site. This is the default.
    • No One: No one can win on this site. This includes your own partner seat. This setting is useful for onboarding offline data or other scenarios where the site needs to be used exclusively for a specific purpose.
    This setting takes precedent over the number of slots made available in the default auction limit parameter. For example, if you make four slots available but do not allow anyone to win on your site, no image pixels will be allowed to fired within your container.
    For more details on whitelisting partners, contact My Oracle Support (MOS).
    Data transfer boostSelect this check box to re-fire the container tag every n seconds after the initial page load while the user is still on the page. This enables you to increase the number of third-party pixels that can be fired from the container, while exceeding the auction slot limit, but without affecting the performance of your page. The container tag can be re-fired a maximum of 15 times. If you cannot insert an <iframe> tag on the web page or if a deployment is implemented using JavaScript. It also can be used to track events that are executed after the web page has initially loaded. The frequency in which the container tag is re-fired depends on the data transfer interval.

    For example, if you set the default auction limit to 10, enable data transfer boost, set the data transfer interval to 7 seconds, and you add 30 third-party pixels to the container, the following will occur:

    1. When the page is initially loaded, the first 10 third-party pixels are fired.
    2. After the Oracle Data Cloud platform receives a DomReady event indicating that the page has completed loading, a 7-second countdown begins.
    3. If the user is still on the page after the countdown, the next 10 third-party pixels are fired. The next 7-second countdown begins.
    4. If the user is still on the page, the last 10 third-party pixels are fired.

    Note: Data transfer boost is enabled by default for new containers.

    Data transfer intervalIf you enabled data transfer boost, specify how frequently (in seconds) the container tag is re-fired.
    LabelsEnter unique, descriptive tags for your container and then press Enter or click the link for the label that appears after you enter the label name. Labels must be two characters or more. You can use labels to help classify your containers in the Containers page.
    NotesEnter a summary or any other relevant information for your container.
  4. Do one of the following to save the container:
    • Click Save to save the container and return to the Containers page. To generate the container tag code later on, do one of the following:
      • Select the check box for the container and then click Generate Code.
      • Select the check box for the container, click Edit to optionally modify the container's settings in the Edit Container dialog, and then click Generate Code.
    • Click Save and Generate Code to save the container and immediately open the Generate Code dialog, where you can create the tag code to be included in the container.
  5. At the top of the Generate Code dialog, click one of the tag types, which control how the container is fired. The code corresponding to the selected tag type is displayed in the read-only code box to the right. The tag types support a number of deployments, such as synchronous for quickly sending user data to the platform or dynamic synchronous for deploying the container inside another tag manager. You can also add phints (key-value pairs) to the container for tagging users with categories and sending the user data to the platform. The Create New Container tool displays the updates to your container tag code as you modify its settings and add phints. It includes a standard configuration template for deploying your containers on mobile websites and hybrid mobile apps.
    Image of the Generate Code dialog
  6. Under Settings, set the following options for the container. The code box to the right is updated as you configure these options:
    OptionDescription
    Site IDSelect the unique site identifier to be used in your tag code. This value overwrites the default auction limit set in the lowest value between the Create New Container dialog and the code generator is the auction limit that is used. The lowest value between the Create New Container dialog and the code generator is the auction limit that is used.
    ProtocolOracle Data Cloud does not support the creation of non-secure tags. Only HTTPS is available.
    Pixel limit per pageviewYou can enter a lower value for this setting to override the Default auction limit value in the Create New Container dialog. The lower of the two values is used.
    Ad server If you are configuring a Media - Impressions or Media - Clicks tag type, select the ad server to be used, such as DFP.
    Creative click thru URLIf you are configuring a Media - Impressions or Media - Clicks tag type, enter the click-thru URL and then click anywhere outside the box or press TAB. The click-thru URL is encoded and added to the tag code.
  7. (Optional) Under Add Phints, add key-value pairs for the categories user are to be tagged with when they visit your website. The phints are passed to the platform and used to classify the user in the DMP. If you are not using a Synchronous, Dynamic Synchronous, or Asynchronous container, which contain the standard Oracle Data Cloud core tag, you must input the phints directly in your URL. To add a phint to the tag code:
    1. Click Add a phint.
    2. In the Key and Value boxes, enter the unique identifier for the data item and the value of the data item, respectively.
  8. If you are configuring a Synchronous, Dynamic Synchronous, or Asynchronous tag type, you can click one of the following server standard templates under Configuration Templatesto automatically configure the tag code with the recommended advanced options:
    Generate Code dialog
  9. (Optional) Configure the tag code by setting advanced options.
  10. In the code box to the right, click Copy to copy the container tag to the clipboard so you can directly paste it into your web pages or save them in a text file. The status of the box changes to Copied to Clipboard.

    Note: The code is not saved in the Generate Code dialog when you click Done. This dialog is only serves as a tag code generator.

  11. Click Done.

Tag types

The Create New Container tool can generate eight different tag types that control how the container is fired and how it collects and transfers user data. All of the following example container tags indicate that the site ID is 15415:

Important: All URIs are assumed to be percent-encoded on the client side.

Advanced configuration options

For synchronous, dynamic synchronous, and asynchronous tags, you can manually configure the tag code by setting the following advanced configuration options in the Generate Code dialog:

Option Description Default
Allow multiple tagging bk_allow_multiple_calls=true
The container tag can be called multiple times for single page applications or page events when this option is selected.
FALSE: The container tag can only be called once.
Suppress multiple tagging Allows only a single tagging call to be made per page. If you select this check box, multiple calls are not suppressed: bk_suppress_multiple_calls=false TRUE: The container tag can only make a single call.
Use multiple iframes bk_use_multiple_iframes=true
Ensures that each request is protected against race conditions for single page apps.
FALSE: The container tag can only use a single IFrame.
Fire inside and outside iframe bk_ignore_outside_iframe=false
Prevents tags from being scheduled directly on the page, outside the iframe that is populated within the container.
TRUE: Tags may only be scheduled inside the iframe.
Disable metadata bk_ignore_meta=true
Prevents your site from passing the title, referrer, and URL to the container.
FALSE: Metadata, including page title, page referrer, and page URL is passed to the platform by default without setting these as explicit phints.
Extract named meta elements bk_meta_vars=[]
Configure this parameter to allow your site to send meta data stored in the HEAD element of a web page (for example, segment, web_section_id, page_content, and so on).
N/A
Extract named global variables bk_js_list=['navigator.appName']
Configure this parameter to allow your site to send page variables.
N/A
Use first-party cookies bk_use_first_party=true
Sets a cookie (bkrid) in the domain of the page that the container tag is hosted on (first-party cookie). The container will read this cookie value as a stable identifier on the user.
FALSE: First-party cookies are not used.
Suppress first-party cookies The default setting prevents the platform from ever setting a cookie (bkrid) in the domain of the page that the container tag is hosted on. If you select this check box, first-party cookies are not suppressed:
bk_suppress_first_party=false
TRUE: First-party cookies may not be set.
Enable debugging bk_is_debug=true
Enables your site to pass additional debugging information to the platform.
FALSE. Debugging information is not sent to the platform.
Allow unlimited GET request length bk_limit_get_length=false
The platform supports unlimited GET requests without truncating the URL. If your site has a significant number of IE6 users, normalize the URL at less than 2000 characters.
TRUE: The length of the GET request is not restricted.
Suppress event scheduling Disables all postMessage support. This will prohibit you from being able to support client-side event handling such as firing tags on onClick events. If you select this check box, event scheduling is not suppressed: bk_suppress_event_scheduling=false TRUE: Events cannot be scheduled.
Suppress cache busting bk_suppress_cache_busting=true
Prevents the forcing of the cache to be broken if the same parameters are sent.
FALSE. Sending the same parameters breaks the cache

Related

Capturing mouse click events

Containers API

Container report

Percent-encoding