Package com.google.openrtb.snippet

Class OpenRtbSnippetProcessor

java.lang.Object

com.google.openrtb.snippet.SnippetProcessor

com.google.openrtb.snippet.OpenRtbSnippetProcessor

@Singleton
public class OpenRtbSnippetProcessor
extends SnippetProcessor

Default SnippetProcessor.

Field Summary

Fields

Modifier and Type	Field	Description
static OpenRtbSnippetProcessor	ORTB_NULL

Fields inherited from class com.google.openrtb.snippet.SnippetProcessor

NULL

Constructor Summary

Constructors

Constructor	Description
OpenRtbSnippetProcessor()	Creates a processor.
OpenRtbSnippetProcessor(boolean extendedFields)	Creates a processor.

Method Summary

Modifier and Type	Method	Description
protected OpenRtb.BidRequest.ImpOrBuilder	findImp(SnippetProcessorContext ctx, SnippetMacroType macro)
void	process(SnippetProcessorContext bidCtx)	Processes the context's response in-place, modifying properties that may contain macros.
protected void	processFields(SnippetProcessorContext bidCtx)	Processes all fields of a bid that should support macro expansion.
protected boolean	processMacroAt(SnippetProcessorContext ctx, SnippetMacroType macroDef)
protected List<SnippetMacroType>	registerMacros()

Methods inherited from class com.google.openrtb.snippet.SnippetProcessor

getEscaper, process, toString, toStringHelper, urlEncode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ORTB_NULL

public static final OpenRtbSnippetProcessor ORTB_NULL

Constructor Detail

OpenRtbSnippetProcessor

public OpenRtbSnippetProcessor(boolean extendedFields)

Creates a processor.

Parameters:

extendedFields - true will support macro substitution in all OpenRtb.BidResponse.SeatBid.Bid fields of string type, not only the adm field mandated by the spec

OpenRtbSnippetProcessor

public OpenRtbSnippetProcessor()

Creates a processor.

Method Detail

registerMacros

protected List<SnippetMacroType> registerMacros()

Overrides:

registerMacros in class SnippetProcessor

processMacroAt

protected boolean processMacroAt(SnippetProcessorContext ctx,
                                 SnippetMacroType macroDef)

Specified by:

processMacroAt in class SnippetProcessor

process

public void process(SnippetProcessorContext bidCtx)

Processes the context's response in-place, modifying properties that may contain macros.

processFields

protected void processFields(SnippetProcessorContext bidCtx)

Processes all fields of a bid that should support macro expansion.

findImp

protected OpenRtb.BidRequest.ImpOrBuilder findImp(SnippetProcessorContext ctx,
                                                  SnippetMacroType macro)