public static final class Augmentor.AugmentorResponse.Macro.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder> 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| Modifier and Type | Method and Description |
|---|---|
Augmentor.AugmentorResponse.Macro.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Augmentor.AugmentorResponse.Macro |
build() |
Augmentor.AugmentorResponse.Macro |
buildPartial() |
Augmentor.AugmentorResponse.Macro.Builder |
clear() |
Augmentor.AugmentorResponse.Macro.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Augmentor.AugmentorResponse.Macro.Builder |
clearName()
optional string name = 1; |
Augmentor.AugmentorResponse.Macro.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Augmentor.AugmentorResponse.Macro.Builder |
clearValue()
optional string value = 2; |
Augmentor.AugmentorResponse.Macro.Builder |
clone() |
Augmentor.AugmentorResponse.Macro |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getName()
optional string name = 1; |
com.google.protobuf.ByteString |
getNameBytes()
optional string name = 1; |
String |
getValue()
optional string value = 2; |
com.google.protobuf.ByteString |
getValueBytes()
optional string value = 2; |
boolean |
hasName()
optional string name = 1; |
boolean |
hasValue()
optional string value = 2; |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Augmentor.AugmentorResponse.Macro.Builder |
mergeFrom(Augmentor.AugmentorResponse.Macro other) |
Augmentor.AugmentorResponse.Macro.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Augmentor.AugmentorResponse.Macro.Builder |
mergeFrom(com.google.protobuf.Message other) |
Augmentor.AugmentorResponse.Macro.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Augmentor.AugmentorResponse.Macro.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Augmentor.AugmentorResponse.Macro.Builder |
setName(String value)
optional string name = 1; |
Augmentor.AugmentorResponse.Macro.Builder |
setNameBytes(com.google.protobuf.ByteString value)
optional string name = 1; |
Augmentor.AugmentorResponse.Macro.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Augmentor.AugmentorResponse.Macro.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Augmentor.AugmentorResponse.Macro.Builder |
setValue(String value)
optional string value = 2; |
Augmentor.AugmentorResponse.Macro.Builder |
setValueBytes(com.google.protobuf.ByteString value)
optional string value = 2; |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Augmentor.AugmentorResponse.Macro build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Augmentor.AugmentorResponse.Macro buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Augmentor.AugmentorResponse.Macro.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder mergeFrom(Augmentor.AugmentorResponse.Macro other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public Augmentor.AugmentorResponse.Macro.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Augmentor.AugmentorResponse.Macro.Builder>IOExceptionpublic boolean hasName()
optional string name = 1;hasName in interface Augmentor.AugmentorResponse.MacroOrBuilderpublic String getName()
optional string name = 1;getName in interface Augmentor.AugmentorResponse.MacroOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
optional string name = 1;getNameBytes in interface Augmentor.AugmentorResponse.MacroOrBuilderpublic Augmentor.AugmentorResponse.Macro.Builder setName(String value)
optional string name = 1;public Augmentor.AugmentorResponse.Macro.Builder clearName()
optional string name = 1;public Augmentor.AugmentorResponse.Macro.Builder setNameBytes(com.google.protobuf.ByteString value)
optional string name = 1;public boolean hasValue()
optional string value = 2;hasValue in interface Augmentor.AugmentorResponse.MacroOrBuilderpublic String getValue()
optional string value = 2;getValue in interface Augmentor.AugmentorResponse.MacroOrBuilderpublic com.google.protobuf.ByteString getValueBytes()
optional string value = 2;getValueBytes in interface Augmentor.AugmentorResponse.MacroOrBuilderpublic Augmentor.AugmentorResponse.Macro.Builder setValue(String value)
optional string value = 2;public Augmentor.AugmentorResponse.Macro.Builder clearValue()
optional string value = 2;public Augmentor.AugmentorResponse.Macro.Builder setValueBytes(com.google.protobuf.ByteString value)
optional string value = 2;public final Augmentor.AugmentorResponse.Macro.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>public final Augmentor.AugmentorResponse.Macro.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>Copyright © 2018. All rights reserved.