Class NonProductPerformanceView.Builder (0.4.0)

public static final class NonProductPerformanceView.Builder extends GeneratedMessageV3.Builder<NonProductPerformanceView.Builder> implements NonProductPerformanceViewOrBuilder

Fields available for query in non_product_performance_view table.

Performance data on images and website links leading to your non-product website pages. This includes performance metrics (for example, clicks) and dimensions according to which performance metrics are segmented (for example, date).

Segment fields cannot be selected in queries without also selecting at least one metric field.

Values are only set for fields requested explicitly in the request's search query.

Protobuf type google.shopping.merchant.reports.v1beta.NonProductPerformanceView

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NonProductPerformanceView.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

build()

public NonProductPerformanceView build()
Returns
TypeDescription
NonProductPerformanceView

buildPartial()

public NonProductPerformanceView buildPartial()
Returns
TypeDescription
NonProductPerformanceView

clear()

public NonProductPerformanceView.Builder clear()
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

clearClickThroughRate()

public NonProductPerformanceView.Builder clearClickThroughRate()

Click-through rate - the number of clicks (clicks) divided by the number of impressions (impressions) of images and website links leading to your non-product website pages. Metric.

optional double click_through_rate = 5;

Returns
TypeDescription
NonProductPerformanceView.Builder

This builder for chaining.

clearClicks()

public NonProductPerformanceView.Builder clearClicks()

Number of clicks on images and website links leading to your non-product website pages. Metric.

optional int64 clicks = 3;

Returns
TypeDescription
NonProductPerformanceView.Builder

This builder for chaining.

clearDate()

public NonProductPerformanceView.Builder clearDate()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
TypeDescription
NonProductPerformanceView.Builder

clearField(Descriptors.FieldDescriptor field)

public NonProductPerformanceView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

clearImpressions()

public NonProductPerformanceView.Builder clearImpressions()

Number of times images and website links leading to your non-product website pages were shown. Metric.

optional int64 impressions = 4;

Returns
TypeDescription
NonProductPerformanceView.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NonProductPerformanceView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

clearWeek()

public NonProductPerformanceView.Builder clearWeek()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Returns
TypeDescription
NonProductPerformanceView.Builder

clone()

public NonProductPerformanceView.Builder clone()
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

getClickThroughRate()

public double getClickThroughRate()

Click-through rate - the number of clicks (clicks) divided by the number of impressions (impressions) of images and website links leading to your non-product website pages. Metric.

optional double click_through_rate = 5;

Returns
TypeDescription
double

The clickThroughRate.

getClicks()

public long getClicks()

Number of clicks on images and website links leading to your non-product website pages. Metric.

optional int64 clicks = 3;

Returns
TypeDescription
long

The clicks.

getDate()

public Date getDate()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
TypeDescription
com.google.type.Date

The date.

getDateBuilder()

public Date.Builder getDateBuilder()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
TypeDescription
com.google.type.Date.Builder

getDateOrBuilder()

public DateOrBuilder getDateOrBuilder()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
TypeDescription
com.google.type.DateOrBuilder

getDefaultInstanceForType()

public NonProductPerformanceView getDefaultInstanceForType()
Returns
TypeDescription
NonProductPerformanceView

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getImpressions()

public long getImpressions()

Number of times images and website links leading to your non-product website pages were shown. Metric.

optional int64 impressions = 4;

Returns
TypeDescription
long

The impressions.

getWeek()

public Date getWeek()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Returns
TypeDescription
com.google.type.Date

The week.

getWeekBuilder()

public Date.Builder getWeekBuilder()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Returns
TypeDescription
com.google.type.Date.Builder

getWeekOrBuilder()

public DateOrBuilder getWeekOrBuilder()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Returns
TypeDescription
com.google.type.DateOrBuilder

hasClickThroughRate()

public boolean hasClickThroughRate()

Click-through rate - the number of clicks (clicks) divided by the number of impressions (impressions) of images and website links leading to your non-product website pages. Metric.

optional double click_through_rate = 5;

Returns
TypeDescription
boolean

Whether the clickThroughRate field is set.

hasClicks()

public boolean hasClicks()

Number of clicks on images and website links leading to your non-product website pages. Metric.

optional int64 clicks = 3;

Returns
TypeDescription
boolean

Whether the clicks field is set.

hasDate()

public boolean hasDate()

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Returns
TypeDescription
boolean

Whether the date field is set.

hasImpressions()

public boolean hasImpressions()

Number of times images and website links leading to your non-product website pages were shown. Metric.

optional int64 impressions = 4;

Returns
TypeDescription
boolean

Whether the impressions field is set.

hasWeek()

public boolean hasWeek()

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Returns
TypeDescription
boolean

Whether the week field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDate(Date value)

public NonProductPerformanceView.Builder mergeDate(Date value)

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
NonProductPerformanceView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NonProductPerformanceView.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public NonProductPerformanceView.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

mergeFrom(NonProductPerformanceView other)

public NonProductPerformanceView.Builder mergeFrom(NonProductPerformanceView other)
Parameter
NameDescription
otherNonProductPerformanceView
Returns
TypeDescription
NonProductPerformanceView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NonProductPerformanceView.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

mergeWeek(Date value)

public NonProductPerformanceView.Builder mergeWeek(Date value)

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
NonProductPerformanceView.Builder

setClickThroughRate(double value)

public NonProductPerformanceView.Builder setClickThroughRate(double value)

Click-through rate - the number of clicks (clicks) divided by the number of impressions (impressions) of images and website links leading to your non-product website pages. Metric.

optional double click_through_rate = 5;

Parameter
NameDescription
valuedouble

The clickThroughRate to set.

Returns
TypeDescription
NonProductPerformanceView.Builder

This builder for chaining.

setClicks(long value)

public NonProductPerformanceView.Builder setClicks(long value)

Number of clicks on images and website links leading to your non-product website pages. Metric.

optional int64 clicks = 3;

Parameter
NameDescription
valuelong

The clicks to set.

Returns
TypeDescription
NonProductPerformanceView.Builder

This builder for chaining.

setDate(Date value)

public NonProductPerformanceView.Builder setDate(Date value)

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
NonProductPerformanceView.Builder

setDate(Date.Builder builderForValue)

public NonProductPerformanceView.Builder setDate(Date.Builder builderForValue)

Date in the merchant timezone to which metrics apply. Segment.

Condition on date is required in the WHERE clause.

.google.type.Date date = 1;

Parameter
NameDescription
builderForValuecom.google.type.Date.Builder
Returns
TypeDescription
NonProductPerformanceView.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NonProductPerformanceView.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

setImpressions(long value)

public NonProductPerformanceView.Builder setImpressions(long value)

Number of times images and website links leading to your non-product website pages were shown. Metric.

optional int64 impressions = 4;

Parameter
NameDescription
valuelong

The impressions to set.

Returns
TypeDescription
NonProductPerformanceView.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NonProductPerformanceView.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final NonProductPerformanceView.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
NonProductPerformanceView.Builder
Overrides

setWeek(Date value)

public NonProductPerformanceView.Builder setWeek(Date value)

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Parameter
NameDescription
valuecom.google.type.Date
Returns
TypeDescription
NonProductPerformanceView.Builder

setWeek(Date.Builder builderForValue)

public NonProductPerformanceView.Builder setWeek(Date.Builder builderForValue)

First day of the week (Monday) of the metrics date in the merchant timezone. Segment.

.google.type.Date week = 2;

Parameter
NameDescription
builderForValuecom.google.type.Date.Builder
Returns
TypeDescription
NonProductPerformanceView.Builder