Class ConversionSpec (0.106.0)

public final class ConversionSpec extends GeneratedMessage 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 Fields

ATTRIBUTION_MODEL_FIELD_NUMBER

public static final int ATTRIBUTION_MODEL_FIELD_NUMBER
Field Value
Type Description
int

CONVERSION_ACTIONS_FIELD_NUMBER

public static final int CONVERSION_ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversionSpec getDefaultInstance()
Returns
Type Description
ConversionSpec

getDescriptor()

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

newBuilder()

public static ConversionSpec.Builder newBuilder()
Returns
Type Description
ConversionSpec.Builder

newBuilder(ConversionSpec prototype)

public static ConversionSpec.Builder newBuilder(ConversionSpec prototype)
Parameter
Name Description
prototype ConversionSpec
Returns
Type Description
ConversionSpec.Builder

parseDelimitedFrom(InputStream input)

public static ConversionSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversionSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConversionSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConversionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversionSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConversionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversionSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConversionSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConversionSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversionSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConversionSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConversionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConversionSpec> parser()
Returns
Type Description
Parser<ConversionSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

getParserForType()

public Parser<ConversionSpec> getParserForType()
Returns
Type Description
Parser<ConversionSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConversionSpec.Builder newBuilderForType()
Returns
Type Description
ConversionSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ConversionSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversionSpec.Builder
Overrides

toBuilder()

public ConversionSpec.Builder toBuilder()
Returns
Type Description
ConversionSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException