com.beeswax.augment

Class Augmentor.AugmentorResponse.Macro

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.beeswax.augment.Augmentor.AugmentorResponse.Macro

All Implemented Interfaces:

Augmentor.AugmentorResponse.MacroOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Augmentor.AugmentorResponse

public static final class Augmentor.AugmentorResponse.Macro
extends com.google.protobuf.GeneratedMessageV3
implements Augmentor.AugmentorResponse.MacroOrBuilder

 The creative's macros {{DYNAMIC:<name>:STRING}} in the value of a
 creative content or creative template, will be replaced with the
 content of `value`.
 For example, if name = "foo", value = "bar", the macro
 {{DYNAMIC:FOO:STRING}} will be replaced with "bar".
 Please note the following constraints:
 (1) Macro values sent via the custom augmentor will apply to whatever
 creative matches to the request. In other words, they are not specific
 to a particular creative or line item.
 (2) Macro name is case-insensitive. (if name = "foo",
 the macro {{DYNAMIC:FOO:STRING}} will still be replaced)
 (3) For a macro to be expanded as an empty string, you should
 explicitly set the macro name in the `name` field, and leave the
 `value` feild empty; Dynamic macros in creatives that does
 not have a match from the `name` field here will not be expanded.
 (4) If a dynamic macro was not expanded, a string of {{DY:<name>}}
 (instead of {{DYNAMIC:<name>:STRING}}) will be placed at where the
 {{DYNAMIC:<name>:STRING}} macro was placed.
 (5) Values of dynamic macros cannot contain other Beeswax macros,
 (including other dynamic macros), as the contained macros will
 not be expanded.
 (6) If the macro is part of a url, the value shold be url-safe
 (e.g, by escaping). Note that click_url is properly escaped as a whole,
 so if the macro is in click_url, its value does not need to
 have extra escaping; url-safe is enough.
 Next id: 3
 

Protobuf type augment.AugmentorResponse.Macro

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Augmentor.AugmentorResponse.Macro.Builder The creative's macros {{DYNAMIC:<name>:STRING}} in the value of a creative content or creative template, will be replaced with the content of `value`.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static com.google.protobuf.Parser<Augmentor.AugmentorResponse.Macro>	PARSER Deprecated.
static int	VALUE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Augmentor.AugmentorResponse.Macro	getDefaultInstance()
Augmentor.AugmentorResponse.Macro	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() optional string name = 1;
com.google.protobuf.ByteString	getNameBytes() optional string name = 1;
com.google.protobuf.Parser<Augmentor.AugmentorResponse.Macro>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getValue() optional string value = 2;
com.google.protobuf.ByteString	getValueBytes() optional string value = 2;
int	hashCode()
boolean	hasName() optional string name = 1;
boolean	hasValue() optional string value = 2;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Augmentor.AugmentorResponse.Macro.Builder	newBuilder()
static Augmentor.AugmentorResponse.Macro.Builder	newBuilder(Augmentor.AugmentorResponse.Macro prototype)
Augmentor.AugmentorResponse.Macro.Builder	newBuilderForType()
protected Augmentor.AugmentorResponse.Macro.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Augmentor.AugmentorResponse.Macro	parseDelimitedFrom(InputStream input)
static Augmentor.AugmentorResponse.Macro	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Augmentor.AugmentorResponse.Macro	parseFrom(byte[] data)
static Augmentor.AugmentorResponse.Macro	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Augmentor.AugmentorResponse.Macro	parseFrom(ByteBuffer data)
static Augmentor.AugmentorResponse.Macro	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Augmentor.AugmentorResponse.Macro	parseFrom(com.google.protobuf.ByteString data)
static Augmentor.AugmentorResponse.Macro	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Augmentor.AugmentorResponse.Macro	parseFrom(com.google.protobuf.CodedInputStream input)
static Augmentor.AugmentorResponse.Macro	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Augmentor.AugmentorResponse.Macro	parseFrom(InputStream input)
static Augmentor.AugmentorResponse.Macro	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Augmentor.AugmentorResponse.Macro>	parser()
Augmentor.AugmentorResponse.Macro.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Augmentor.AugmentorResponse.Macro> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasName

public boolean hasName()

optional string name = 1;

Specified by:

hasName in interface Augmentor.AugmentorResponse.MacroOrBuilder

getName

public String getName()

optional string name = 1;

Specified by:

getName in interface Augmentor.AugmentorResponse.MacroOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

optional string name = 1;

Specified by:

getNameBytes in interface Augmentor.AugmentorResponse.MacroOrBuilder

hasValue

public boolean hasValue()

optional string value = 2;

Specified by:

hasValue in interface Augmentor.AugmentorResponse.MacroOrBuilder

getValue

public String getValue()

optional string value = 2;

Specified by:

getValue in interface Augmentor.AugmentorResponse.MacroOrBuilder

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

optional string value = 2;

Specified by:

getValueBytes in interface Augmentor.AugmentorResponse.MacroOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Augmentor.AugmentorResponse.Macro parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Augmentor.AugmentorResponse.Macro parseDelimitedFrom(InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(com.google.protobuf.CodedInputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Augmentor.AugmentorResponse.Macro parseFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

newBuilderForType

public Augmentor.AugmentorResponse.Macro.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Augmentor.AugmentorResponse.Macro.Builder newBuilder()

newBuilder

public static Augmentor.AugmentorResponse.Macro.Builder newBuilder(Augmentor.AugmentorResponse.Macro prototype)

toBuilder

public Augmentor.AugmentorResponse.Macro.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Augmentor.AugmentorResponse.Macro.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Augmentor.AugmentorResponse.Macro getDefaultInstance()

parser

public static com.google.protobuf.Parser<Augmentor.AugmentorResponse.Macro> parser()

getParserForType

public com.google.protobuf.Parser<Augmentor.AugmentorResponse.Macro> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Augmentor.AugmentorResponse.Macro getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder