Page tree
Skip to end of metadata
Go to start of metadata

On This Page:

Invocation tags can be configured to operate in a number of different ways.

All invocation tags in Revive Adserver - both for zones and for websites - can be configured to operate in different ways. e

The table below lists all possible tag options for invocation tags.



 

Tag OptionDescriptionSupporting Invocation Tag Types

Automatically close after

This option defines how many seconds the pop-up/pop-under banner should be displayed for, after which time the pop-up/pop-under window should automatically be closed.

When not set, the pop-up/pop-under window will not be automatically closed.

  • Popup

Character set

TO BE DOCUMENTED
  • JavaScript
  • Single Page Call
  • Local Mode
  • XML-RPC
  • Interstitial or Floating DHTML

Don't show the banner again on the same page

When enabled (i.e. Yes selected), then if a banner is displayed in a zone, then Revive Adserver will not allow that same banner to be displayed again in any other zone (or any repeat instance of the zone, if the zone is included on the page more than once) on the same page view.
  • Asynchronous JS
  • JavaScript
  • Single Page Call
  • Local Mode
  • XML-RPC

Don't show a banner from the same campaign again on the same page

When enabled (i.e. Yes selected), then if a banner is displayed in a zone, then Revive Adserver will not allow that banner or any other banner from that banner's campaign to be displayed again in any other zone (or any repeat instance of the zone, if the zone is included on the page more than once) on the same page view.

  • Asynchronous JS
  • JavaScript
  • Single Page Call
  • Local Mode
  • XML-RPC

Host Language

TO BE DOCUMENTED
  • XML-RPC

Include code to track Google AdSense clicks

In order for Google Adsense click tracking to work in an iFrame, Revive Adserver must set a unique cookie for each zone. When enabled (i.e. Yes selected), the zone invocation tag will create a cookie so that click tracking will work.

Warning: A different cookie will be required for each iFrame, and using this setting may pollute your adserver's cookie space.

Documentation note: This setting may not work, and needs to be checked.

  • iFrame

Include comments

Many Revive Adserver invocation tags are generated with comments which can help with understanding how to use the tags - for example, suggesting changes that may need to be made to the tag to work on an SSL secured site, additional information that may need to be added to set size information, script or program paths, etc. However, for users familiar with the use of invocation tags, these comments may not be necessary, and the comments may add unwanted size to the tags.

When disabled (i.e. No selected), the invocation tags will be generated without these comments.

It is recommended that tags be generated with comments in the first instance, and then re-generated without comments if necessary, after the comments have been reviewed.

  • JavaScript
  • Single Page Call
  • iFrame
  • Local Mode
  • XML-RPC
  • Image
  • No Cookie Image
  • Popup

Include Netscape 4 compatible layer

TO BE DOCUMENTED
  • iFrame

Initial position (left)

This option defines where the pop-up/pop-under window should be positioned on the user's screen with regards to the X-axis (left/right axis), relative to the underlying browser window. Both positive and negative integer values are permitted, where positive values indicate the number of pixels that the pop-up/pop-under window should be opened to the right of the left-most edge of the underlying browser window, while negative values indicate the number of pixels that the pop-up/pop-under windows should be opened to the left of the left-most edge of the underlying browser window.

By default, pop-up/pop-under windows are opened without informing the browser where on the X-axis to position the window, leaving it to browser defaults.

  • Popup

Initial position (top)

This option defines where the pop-up/pop-under window should be positioned on the user's screen with regards to the Y-axis (up/down axis), relative to the underlying browser window. Both positive and negative integer values are permitted, where positive values indicate the number of pixels that the pop-up/pop-under window should be opened underneath the top-most edge of the underlying browser window, while negative values indicate the number of pixels that the pop-up/pop-under windows should be opened above the top-most edge of the underlying browser window.

By default, pop-up/pop-under windows are opened without informing the browser where on the Y-axis to position the window, leaving it to browser defaults.

  • Popup

Insert Cache-Busting code

For non-JavaScript based tags, when enabled (i.e. Yes selected), the tag will be generated with one or more instances of the text "INSERT_RANDOM_NUMBER_HERE" in the tag. If you have the ability to do so, your website should replace this text with a randomly generated number; by doing so, this will help reduce the possibility of the user's web browser displaying a previously viewed banner from their browser or upstream proxy cache.

In the event that you do not have the ability to programmatically modify invocation tags, you can either disable this option or simply ignore the text, and leave it as generated - leaving the generated "INSERT_RANDOM_NUMBER_HERE" text in place will not stop the tag from working.

Documentation note: Local Mode & XML-RPC tags - see https://github.com/revive-adserver/revive-adserver/issues/542

  • iFrame
  • Local Mode
  • XML-RPC
  • Image
  • No Cookie Image
  • Popup

Instance when the pop-up is created

TO BE DOCUMENTED
  • Popup

Make the iframe transparent

TO BE DOCUMENTED
  • iFrame

Option - noscript

When enabled (i.e. Yes selected), then the website invocation tags will be generated with a JavaScript <noscript> backup option, to display a banner to the user via a simple <img> tag in the event that the user's device does not support JavaScript.

Note, however, that should the <noscript> fallback be used, however, that other options specific for the Single Page Call tag (such as not showing the same banner again, or not showing another banner from the same campaign) will not work. Some users may prefer to not show any banner at all if JavaScript is not supported, in which case the feature should be disabled.

  • Single Page Call

Option - SSL

Generating the Single Page Call tag for all zones in a website may potentially generate a large number of zone tags. To save having to change all of these tags manually for display on an SSL secured page, enabling this option (i.e. selecting Yes) will generate all of the tags with https:// support already in place.
  • Single Page Call

Pop-up type

This option defines if the banner should be displayed as a pop-up (where the banner appears in a new window on top of the user's current window), or a pop-under (where the banner appears in a new window behind the user's current window).

Documentation note: Pop-unders may no longer be supported - see https://github.com/revive-adserver/revive-adserver/issues/551

  • Popup

Refresh after

TO BE DOCUMENTED
  • iFrame

Show text below banner

For those banner types that support it (SQL, web and URL only), enabling this option (i.e. selecting Yes) will allow the display of text below the banner, when defined in that banner's "Banner display > Text below image" option.

If the banner displayed has no option set for the "Banner display > Text below image", or if the banner type does not support the display of text below the banner, this this tag option setting will have no effect.

  • JavaScript
  • Single Page Call
  • Local Mode
  • XML-RPC

Source

When desired, a source value may be supplied, which will be passed into Revive Adserver when the invocation tag is called.

The value of the source parameter will then be available to be used during banner selection by the Site - Source delivery rule.

  • Asynchronous JS
  • JavaScript
  • Single Page Call
  • iFrame
  • Local Mode
  • XML-RPC
  • Image
  • No Cookie Image
  • Interstitial or Floating DHTML
  • Popup

Store the banner inside a variable so it can be used in a template

By default, the local mode zone invocation tag selects a banner and outputs the necessary HTML to display this banner. By enabling this option (i.e. selecting Yes), the invocation tag will be generated in a format where the HTML required to display the banner will not be output. Instead, the HTML will be stored in the $phpAds_raw['html'] variable, which can then be used elsewhere in your site's PHP code.

  • Local Mode

Support 3rd Party Server Clicktracking

Once generated, a zone invocation tag needs to be placed in the HTML of a web page to be displayed. While the normal approach is to place the zone invocation tag directly in the HTML code of the required web pages, where the zone should be displayed, it is also possible to take the zone invocation tag, and put the tag as a banner in another ad serving system.

When this approach is taken, there are now two ad servers in play - the ad serving system that is called from the HTML code, which then delivers the zone invocation tag from your Revive Adserver system (which then delivers an actual banner).

Under these circumstances, it may be desirable for both systems to be able to record clicks on the banner. (Due to the way communications work, please note though that this will never be perfect, and you should always consider Revive Adserver's statistics for banners it has delivered to be the definitive record.)

As your Revive Adserver system was the system that actually delivered the banner shown to the user, it will have done so in a way that a click will come back to Revive Adserver, and from there, the user will be shown the target page. This means that the other system - the one that the ad zone invocation tag was delivered through - will not know about the click.

To address this, the Support 3rd Party Server Clicktracking option modifies the zone invocation tag, to allow Revive Adserver to notify the other system of any clicks on the banners it delivers.

Specific supported 3rd party systems include special code that the other system knows how to automatically replace, so that Revive Adserver will be informed of the correct way to send click information to that server. If you are delivering a zone invocation tag through one of the specific supported 3rd party systems, just select the system when you generate your zone invocation tag, and then put the tag into that system for delivery.

Otherwise, if you are using a different 3rd party system, select the Generic option, and your zone invocation tag will be generated with the INSERT_ENCODED_CLICKURL_HERE text present.

This text in the zone invocation needs to be replaced with the correct click tracking URL for the 3rd party system.

  • Asynchronous JS
  • JavaScript
  • iFrame
  • Local Mode
  • XML-RPC
  • Image
  • No Cookie Image
  • Popup

Target frame

TO BE DOCUMENTED
  • Asynchronous JS
  • JavaScript
  • Single Page Call
  • iFrame
  • Local Mode
  • XML-RPC
  • Image
  • No Cookie Image
  • Interstitial or Floating DHTML
  • Popup

Use HTTPS to contact XML-RPC Server

Enabling this option (i.e. selecting Yes) will generate the XML-RPC zone invocation tag so that it uses SSL for the XML-RPC connection. Your Revive Adserver installation must be configured to respond using https:// calls on port 443 for this to work.
  • XML-RPC

XML-RPC Timeout (Seconds)

This option defines the number of seconds the XML-RPC tag should wait for a connection to your Revive Adserver before timing out and not displaying a banner. By default, XML-RPC tags are generated with a timeout value of 15 seconds.
  • XML-RPC



Interstitial or Floating DHTML Tags
  • Style:

Further options based on style to be documented...

Popup Tags

  • Window options:
    • Toolbars:
    • Location:
    • Menubar:
    • Status:
    • Resizable:
    • Scrollbars:
  • No labels