Class AttributionSettings (0.58.0)

public final class AttributionSettings extends GeneratedMessageV3 implements AttributionSettingsOrBuilder

The attribution settings used for a given property. This is a singleton resource.

Protobuf type google.analytics.admin.v1alpha.AttributionSettings

Static Fields

ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_FIELD_NUMBER

public static final int ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_FIELD_NUMBER
Field Value
Type Description
int

ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_FIELD_NUMBER

public static final int ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_FIELD_NUMBER

public static final int OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_FIELD_NUMBER
Field Value
Type Description
int

REPORTING_ATTRIBUTION_MODEL_FIELD_NUMBER

public static final int REPORTING_ATTRIBUTION_MODEL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AttributionSettings getDefaultInstance()
Returns
Type Description
AttributionSettings

getDescriptor()

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

newBuilder()

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

newBuilder(AttributionSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAcquisitionConversionEventLookbackWindow()

public AttributionSettings.AcquisitionConversionEventLookbackWindow getAcquisitionConversionEventLookbackWindow()

Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.

.google.analytics.admin.v1alpha.AttributionSettings.AcquisitionConversionEventLookbackWindow acquisition_conversion_event_lookback_window = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AttributionSettings.AcquisitionConversionEventLookbackWindow

The acquisitionConversionEventLookbackWindow.

getAcquisitionConversionEventLookbackWindowValue()

public int getAcquisitionConversionEventLookbackWindowValue()

Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.

.google.analytics.admin.v1alpha.AttributionSettings.AcquisitionConversionEventLookbackWindow acquisition_conversion_event_lookback_window = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for acquisitionConversionEventLookbackWindow.

getAdsWebConversionDataExportScope()

public AttributionSettings.AdsWebConversionDataExportScope getAdsWebConversionDataExportScope()

Required. The Conversion Export Scope for data exported to linked Ads Accounts.

.google.analytics.admin.v1alpha.AttributionSettings.AdsWebConversionDataExportScope ads_web_conversion_data_export_scope = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AttributionSettings.AdsWebConversionDataExportScope

The adsWebConversionDataExportScope.

getAdsWebConversionDataExportScopeValue()

public int getAdsWebConversionDataExportScopeValue()

Required. The Conversion Export Scope for data exported to linked Ads Accounts.

.google.analytics.admin.v1alpha.AttributionSettings.AdsWebConversionDataExportScope ads_web_conversion_data_export_scope = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for adsWebConversionDataExportScope.

getDefaultInstanceForType()

public AttributionSettings getDefaultInstanceForType()
Returns
Type Description
AttributionSettings

getName()

public String getName()

Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getOtherConversionEventLookbackWindow()

public AttributionSettings.OtherConversionEventLookbackWindow getOtherConversionEventLookbackWindow()

Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.

.google.analytics.admin.v1alpha.AttributionSettings.OtherConversionEventLookbackWindow other_conversion_event_lookback_window = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AttributionSettings.OtherConversionEventLookbackWindow

The otherConversionEventLookbackWindow.

getOtherConversionEventLookbackWindowValue()

public int getOtherConversionEventLookbackWindowValue()

Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.

.google.analytics.admin.v1alpha.AttributionSettings.OtherConversionEventLookbackWindow other_conversion_event_lookback_window = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for otherConversionEventLookbackWindow.

getParserForType()

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

getReportingAttributionModel()

public AttributionSettings.ReportingAttributionModel getReportingAttributionModel()

Required. The reporting attribution model used to calculate conversion credit in this property's reports.

Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.

.google.analytics.admin.v1alpha.AttributionSettings.ReportingAttributionModel reporting_attribution_model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AttributionSettings.ReportingAttributionModel

The reportingAttributionModel.

getReportingAttributionModelValue()

public int getReportingAttributionModelValue()

Required. The reporting attribution model used to calculate conversion credit in this property's reports.

Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.

.google.analytics.admin.v1alpha.AttributionSettings.ReportingAttributionModel reporting_attribution_model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for reportingAttributionModel.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AttributionSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AttributionSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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