Class ConversionSpec.Builder (0.106.0)

public static final class ConversionSpec.Builder extends GeneratedMessage.Builder<ConversionSpec.Builder> implements ConversionSpecOrBuilder

Controls conversion reporting.

<aside class="caution"> This feature may not be available to your Google Analytics property. The Google Analytics team is actively working to expand this feature to more properties. Please reach out to your <a href="https://support.google.com/analytics/gethelp">support team</a> if you have questions about the eligibility of your property. </aside>

Protobuf type google.analytics.data.v1alpha.ConversionSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllConversionActions(Iterable<String> values)

public ConversionSpec.Builder addAllConversionActions(Iterable<String> values)

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Parameter
Name Description
values Iterable<String>

The conversionActions to add.

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

addConversionActions(String value)

public ConversionSpec.Builder addConversionActions(String value)

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Parameter
Name Description
value String

The conversionActions to add.

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

addConversionActionsBytes(ByteString value)

public ConversionSpec.Builder addConversionActionsBytes(ByteString value)

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Parameter
Name Description
value ByteString

The bytes of the conversionActions to add.

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

build()

public ConversionSpec build()
Returns
Type Description
ConversionSpec

buildPartial()

public ConversionSpec buildPartial()
Returns
Type Description
ConversionSpec

clear()

public ConversionSpec.Builder clear()
Returns
Type Description
ConversionSpec.Builder
Overrides

clearAttributionModel()

public ConversionSpec.Builder clearAttributionModel()

The attribution model to use in the Conversion Report. If unspecified, DATA_DRIVEN is used.

.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

clearConversionActions()

public ConversionSpec.Builder clearConversionActions()

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

getAttributionModel()

public ConversionSpec.AttributionModel getAttributionModel()

The attribution model to use in the Conversion Report. If unspecified, DATA_DRIVEN is used.

.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;

Returns
Type Description
ConversionSpec.AttributionModel

The attributionModel.

getAttributionModelValue()

public int getAttributionModelValue()

The attribution model to use in the Conversion Report. If unspecified, DATA_DRIVEN is used.

.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;

Returns
Type Description
int

The enum numeric value on the wire for attributionModel.

getConversionActions(int index)

public String getConversionActions(int index)

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The conversionActions at the given index.

getConversionActionsBytes(int index)

public ByteString getConversionActionsBytes(int index)

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the conversionActions at the given index.

getConversionActionsCount()

public int getConversionActionsCount()

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Returns
Type Description
int

The count of conversionActions.

getConversionActionsList()

public ProtocolStringList getConversionActionsList()

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Returns
Type Description
ProtocolStringList

A list containing the conversionActions.

getDefaultInstanceForType()

public ConversionSpec getDefaultInstanceForType()
Returns
Type Description
ConversionSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ConversionSpec other)

public ConversionSpec.Builder mergeFrom(ConversionSpec other)
Parameter
Name Description
other ConversionSpec
Returns
Type Description
ConversionSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConversionSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConversionSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConversionSpec.Builder
Overrides

setAttributionModel(ConversionSpec.AttributionModel value)

public ConversionSpec.Builder setAttributionModel(ConversionSpec.AttributionModel value)

The attribution model to use in the Conversion Report. If unspecified, DATA_DRIVEN is used.

.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;

Parameter
Name Description
value ConversionSpec.AttributionModel

The attributionModel to set.

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

setAttributionModelValue(int value)

public ConversionSpec.Builder setAttributionModelValue(int value)

The attribution model to use in the Conversion Report. If unspecified, DATA_DRIVEN is used.

.google.analytics.data.v1alpha.ConversionSpec.AttributionModel attribution_model = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for attributionModel to set.

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.

setConversionActions(int index, String value)

public ConversionSpec.Builder setConversionActions(int index, String value)

The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the conversion_action field within the conversions list in the response of the GetMetadata method. For example, 'conversionActions/1234'.

repeated string conversion_actions = 1;

Parameters
Name Description
index int

The index to set the value at.

value String

The conversionActions to set.

Returns
Type Description
ConversionSpec.Builder

This builder for chaining.