Advanced

Overview 🔗

EzoicAds provides advanced features that allow publishers to fine-tune the behavior of the ad library. These features can be used to customize the behavior of the ad library to better suit the needs of your site.

Configurable Options 🔗

There are configurable options available in EzoicAds that can be used to customize the behavior of the ad library. These options can be set using the ezstandalone.config() function.

Setting Configuration Options 🔗

To set configuration options, use the following syntax:

1ezstandalone.cmd.push(function() {
2    ezstandalone.config({
3        // Configuration options go here
4    });
5});

Place this code after the EzoicAds header script, but before calling ezstandalone.enable() or ezstandalone.showAds().

Available Options 🔗

Limit Cookies 🔗

When enabled, the Limit Cookies feature ensures that only essential cookies required by Ezoic are included by default. This provides greater control over user privacy and helps with compliance to various data protection regulations.

To enable Limit Cookies:

1ezstandalone.cmd.push(function() {
2    ezstandalone.config({ limitCookies: true });
3});

Anchor Ad Position 🔗

Allows you to change the position of the Anchor Ad to be at the top or bottom of the page. Acceptable values are 'top' or 'bottom'. The Anchor Ad will be located at the bottom of the page by default.

For example to set the anchor ad position to be at the top of the page:

1ezstandalone.cmd.push(function() {
2    ezstandalone.config({ anchorAdPosition: "top" });
3});

More options will be added in the future. Please check back for updates.

Tracking Data 🔗

If you would like to track data even on pages that are not showing ads you can include the script below. This is specifically helpful in the starting stages of testing when you are not ready to show ads yet.

1<script src="//ezoicanalytics.com/analytics.js"></script>

Splitting Traffic 🔗

Unlike our other integration methods, splitting traffic happens clientside.

Using the ezstandalone.isEzoicUser function, you can split traffic on a percentage of your traffic.

Example 🔗

Below is an example of splitting 50 percent of your traffic with Ezoic.

 1<script type="text/javascript">
 2    ezstandalone.cmd = ezstandalone.cmd || [];
 3    ezstandalone.cmd.push(function() {
 4        var percentageToRunEzoic = 50;
 5        if(ezstandalone.isEzoicUser(percentageToRunEzoic)) {
 6            ezstandalone.showAds(100, 101);
 7        } else {
 8            // Normal ad code execution
 9        }
10    });
11</script>

ShowAds Advanced Usage 🔗

The advanced implementation provides additional functionality by accepting an array of objects. Each object can include the following attributes:

• id (required): The unique identifier of the placeholder where the ad should be shown.
• required (optional, boolean): A flag indicating whether the ad must be displayed. If set to true, the system will force an ad to be shown in the specified placeholder, even if it would not normally be displayed.
• sizes (optional, string or array of strings): Specifies the allowed sizes for the ad in the format '{width}x{height}'. You can provide a single size as a string or multiple sizes as an array of strings. This allows you to control the dimensions of the ad that will be displayed.

Example 🔗

1<script>
2var placeholders = [
3    { id: 103, required: true, sizes: ['336x280', '126x126'] },
4    { id: 104, sizes: '1000x450' },  
5    { id: 105, required: true },
6];
7
8ezstandalone.showAds(placeholders);
9</script>

In this example:

1. Placeholder 103:

   • An ad will always be displayed in placeholder 103.
   • The allowed sizes for the ad are 336x280 and 126x126.

2. Placeholder 104:

   • An ad will be displayed in placeholder 104 if Ezoic decides this ad should be shown.
   • The allowed size for the ad is 1000x450.

3. Placeholder 105:

   • An ad will always be displayed in placeholder 105.
   • No specific sizes are provided, so Ezoic will decide the best size for this placeholder.

Notes 🔗

• Specificity of Ad Sizes: The ad sizes specified in the sizes attribute are treated as specific requests. Ezoic will attempt to find the best possible ad that fits the given size. If an exact match is not available, the system will choose the closest available size that can best fit within the specified dimensions.
• If the required attribute is set to true, Ezoic will prioritize showing the ad in that placeholder, ensuring it is displayed even if other conditions might normally prevent it.
• If sizes are specified, the ad will only be displayed if an ad of the specified sizes is available. If the sizes attribute is omitted or left empty, Ezoic will use its default behavior to determine the ad size.

Use Cases 🔗

• Guaranteed Ad Placement: Use the required attribute to ensure that ads are shown in critical placeholders, regardless of other conditions.
• Size-Specific Ads: Use the sizes attribute to control the dimensions of the ads being displayed. This is particularly useful for responsive designs or specific layout requirements where certain sizes are more effective.

RefreshAds 🔗

refreshAds allows for placeholders to be refreshed without needing to call destroyPlaceholders and showAds. This is useful for sites with dynamic content or infinite scroll where the content changes but the placeholders remain the same.

Multiple placeholders can be passed in as an array of IDs.

Example 🔗

1<script>
2    ezstandalone.cmd.push(function() {
3        ezstandalone.refreshAds(101, 102)
4    });
5</script>