Augmentor.AugmentorResponse.Macro.Builder (Beeswax API 2018-03-13 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
    - - com.beeswax.augment.Augmentor.AugmentorResponse.Macro.Builder

All Implemented Interfaces:: Augmentor.AugmentorResponse.MacroOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Augmentor.AugmentorResponse.Macro

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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;`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - 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.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - clear
```
public Augmentor.AugmentorResponse.Macro.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - getDefaultInstanceForType
```
public Augmentor.AugmentorResponse.Macro getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Augmentor.AugmentorResponse.Macro build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Augmentor.AugmentorResponse.Macro buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Augmentor.AugmentorResponse.Macro.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - setField
```
public Augmentor.AugmentorResponse.Macro.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - clearField
```
public Augmentor.AugmentorResponse.Macro.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - clearOneof
```
public Augmentor.AugmentorResponse.Macro.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - setRepeatedField
```
public Augmentor.AugmentorResponse.Macro.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  int index,
                                                                  Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - addRepeatedField
```
public Augmentor.AugmentorResponse.Macro.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - mergeFrom
```
public Augmentor.AugmentorResponse.Macro.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - mergeFrom
```
public Augmentor.AugmentorResponse.Macro.Builder mergeFrom(Augmentor.AugmentorResponse.Macro other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - mergeFrom
```
public Augmentor.AugmentorResponse.Macro.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Augmentor.AugmentorResponse.Macro.Builder>
    
    Throws:
    
    IOException
  - 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
  - setName
```
public Augmentor.AugmentorResponse.Macro.Builder setName(String value)
```
    optional string name = 1;
  - clearName
```
public Augmentor.AugmentorResponse.Macro.Builder clearName()
```
    optional string name = 1;
  - setNameBytes
```
public Augmentor.AugmentorResponse.Macro.Builder setNameBytes(com.google.protobuf.ByteString value)
```
    optional string name = 1;
  - 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
  - setValue
```
public Augmentor.AugmentorResponse.Macro.Builder setValue(String value)
```
    optional string value = 2;
  - clearValue
```
public Augmentor.AugmentorResponse.Macro.Builder clearValue()
```
    optional string value = 2;
  - setValueBytes
```
public Augmentor.AugmentorResponse.Macro.Builder setValueBytes(com.google.protobuf.ByteString value)
```
    optional string value = 2;
  - setUnknownFields
```
public final Augmentor.AugmentorResponse.Macro.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>
  - mergeUnknownFields
```
public final Augmentor.AugmentorResponse.Macro.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Augmentor.AugmentorResponse.Macro.Builder>

Class Augmentor.AugmentorResponse.Macro.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasName

getName

getNameBytes

setName

clearName

setNameBytes

hasValue

getValue

getValueBytes

setValue

clearValue

setValueBytes

setUnknownFields

mergeUnknownFields