Class YoutubeProductPerformanceView.Builder (0.44.0)

public static final class YoutubeProductPerformanceView.Builder extends GeneratedMessageV3.Builder<YoutubeProductPerformanceView.Builder> implements YoutubeProductPerformanceViewOrBuilder

Fields available for query in youtube_product_performance_view table.

YouTube product performance data for your account. This data is only available if an account is enrolled in the YouTube Shopping Affiliate program.

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

Protobuf type google.shopping.merchant.reports.v1alpha.YoutubeProductPerformanceView

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public YoutubeProductPerformanceView.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

build()

public YoutubeProductPerformanceView build()
Returns
Type Description
YoutubeProductPerformanceView

buildPartial()

public YoutubeProductPerformanceView buildPartial()
Returns
Type Description
YoutubeProductPerformanceView

clear()

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

clearClicks()

public YoutubeProductPerformanceView.Builder clearClicks()

The number of product clicks.

optional int64 clicks = 10;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clearCommissions()

public YoutubeProductPerformanceView.Builder clearCommissions()

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Returns
Type Description
YoutubeProductPerformanceView.Builder

clearDate()

public YoutubeProductPerformanceView.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
Type Description
YoutubeProductPerformanceView.Builder

clearDistinctCreatorCount()

public YoutubeProductPerformanceView.Builder clearDistinctCreatorCount()

The number of distinct creator channels the product was shown on.

optional int64 distinct_creator_count = 5;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clearDistinctVideoCount()

public YoutubeProductPerformanceView.Builder clearDistinctVideoCount()

The number of distinct videos the product was shown on.

optional int64 distinct_video_count = 4;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public YoutubeProductPerformanceView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

clearGrossSales()

public YoutubeProductPerformanceView.Builder clearGrossSales()

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Returns
Type Description
YoutubeProductPerformanceView.Builder

clearNetSales()

public YoutubeProductPerformanceView.Builder clearNetSales()

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Returns
Type Description
YoutubeProductPerformanceView.Builder

clearOfferId()

public YoutubeProductPerformanceView.Builder clearOfferId()

The merchant-provided product id.

optional string offer_id = 3;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public YoutubeProductPerformanceView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

clearOrders()

public YoutubeProductPerformanceView.Builder clearOrders()

The number of orders.

optional int64 orders = 8;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clearTitle()

public YoutubeProductPerformanceView.Builder clearTitle()

The product title.

optional string title = 2;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clearViews()

public YoutubeProductPerformanceView.Builder clearViews()

The number of YouTube views.

optional int64 views = 9;

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

clone()

public YoutubeProductPerformanceView.Builder clone()
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

getClicks()

public long getClicks()

The number of product clicks.

optional int64 clicks = 10;

Returns
Type Description
long

The clicks.

getCommissions()

public Price getCommissions()

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Returns
Type Description
com.google.shopping.type.Price

The commissions.

getCommissionsBuilder()

public Price.Builder getCommissionsBuilder()

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Returns
Type Description
com.google.shopping.type.Price.Builder

getCommissionsOrBuilder()

public PriceOrBuilder getCommissionsOrBuilder()

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

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
Type Description
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
Type Description
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
Type Description
com.google.type.DateOrBuilder

getDefaultInstanceForType()

public YoutubeProductPerformanceView getDefaultInstanceForType()
Returns
Type Description
YoutubeProductPerformanceView

getDescriptorForType()

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

getDistinctCreatorCount()

public long getDistinctCreatorCount()

The number of distinct creator channels the product was shown on.

optional int64 distinct_creator_count = 5;

Returns
Type Description
long

The distinctCreatorCount.

getDistinctVideoCount()

public long getDistinctVideoCount()

The number of distinct videos the product was shown on.

optional int64 distinct_video_count = 4;

Returns
Type Description
long

The distinctVideoCount.

getGrossSales()

public Price getGrossSales()

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Returns
Type Description
com.google.shopping.type.Price

The grossSales.

getGrossSalesBuilder()

public Price.Builder getGrossSalesBuilder()

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Returns
Type Description
com.google.shopping.type.Price.Builder

getGrossSalesOrBuilder()

public PriceOrBuilder getGrossSalesOrBuilder()

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

getNetSales()

public Price getNetSales()

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Returns
Type Description
com.google.shopping.type.Price

The netSales.

getNetSalesBuilder()

public Price.Builder getNetSalesBuilder()

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Returns
Type Description
com.google.shopping.type.Price.Builder

getNetSalesOrBuilder()

public PriceOrBuilder getNetSalesOrBuilder()

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Returns
Type Description
com.google.shopping.type.PriceOrBuilder

getOfferId()

public String getOfferId()

The merchant-provided product id.

optional string offer_id = 3;

Returns
Type Description
String

The offerId.

getOfferIdBytes()

public ByteString getOfferIdBytes()

The merchant-provided product id.

optional string offer_id = 3;

Returns
Type Description
ByteString

The bytes for offerId.

getOrders()

public long getOrders()

The number of orders.

optional int64 orders = 8;

Returns
Type Description
long

The orders.

getTitle()

public String getTitle()

The product title.

optional string title = 2;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

The product title.

optional string title = 2;

Returns
Type Description
ByteString

The bytes for title.

getViews()

public long getViews()

The number of YouTube views.

optional int64 views = 9;

Returns
Type Description
long

The views.

hasClicks()

public boolean hasClicks()

The number of product clicks.

optional int64 clicks = 10;

Returns
Type Description
boolean

Whether the clicks field is set.

hasCommissions()

public boolean hasCommissions()

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Returns
Type Description
boolean

Whether the commissions 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
Type Description
boolean

Whether the date field is set.

hasDistinctCreatorCount()

public boolean hasDistinctCreatorCount()

The number of distinct creator channels the product was shown on.

optional int64 distinct_creator_count = 5;

Returns
Type Description
boolean

Whether the distinctCreatorCount field is set.

hasDistinctVideoCount()

public boolean hasDistinctVideoCount()

The number of distinct videos the product was shown on.

optional int64 distinct_video_count = 4;

Returns
Type Description
boolean

Whether the distinctVideoCount field is set.

hasGrossSales()

public boolean hasGrossSales()

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Returns
Type Description
boolean

Whether the grossSales field is set.

hasNetSales()

public boolean hasNetSales()

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Returns
Type Description
boolean

Whether the netSales field is set.

hasOfferId()

public boolean hasOfferId()

The merchant-provided product id.

optional string offer_id = 3;

Returns
Type Description
boolean

Whether the offerId field is set.

hasOrders()

public boolean hasOrders()

The number of orders.

optional int64 orders = 8;

Returns
Type Description
boolean

Whether the orders field is set.

hasTitle()

public boolean hasTitle()

The product title.

optional string title = 2;

Returns
Type Description
boolean

Whether the title field is set.

hasViews()

public boolean hasViews()

The number of YouTube views.

optional int64 views = 9;

Returns
Type Description
boolean

Whether the views field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommissions(Price value)

public YoutubeProductPerformanceView.Builder mergeCommissions(Price value)

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
YoutubeProductPerformanceView.Builder

mergeDate(Date value)

public YoutubeProductPerformanceView.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
Name Description
value com.google.type.Date
Returns
Type Description
YoutubeProductPerformanceView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(YoutubeProductPerformanceView other)

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

mergeGrossSales(Price value)

public YoutubeProductPerformanceView.Builder mergeGrossSales(Price value)

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
YoutubeProductPerformanceView.Builder

mergeNetSales(Price value)

public YoutubeProductPerformanceView.Builder mergeNetSales(Price value)

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
YoutubeProductPerformanceView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final YoutubeProductPerformanceView.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

setClicks(long value)

public YoutubeProductPerformanceView.Builder setClicks(long value)

The number of product clicks.

optional int64 clicks = 10;

Parameter
Name Description
value long

The clicks to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setCommissions(Price value)

public YoutubeProductPerformanceView.Builder setCommissions(Price value)

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
YoutubeProductPerformanceView.Builder

setCommissions(Price.Builder builderForValue)

public YoutubeProductPerformanceView.Builder setCommissions(Price.Builder builderForValue)

The commissions amount (pending and paid).

optional .google.shopping.type.Price commissions = 7;

Parameter
Name Description
builderForValue com.google.shopping.type.Price.Builder
Returns
Type Description
YoutubeProductPerformanceView.Builder

setDate(Date value)

public YoutubeProductPerformanceView.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
Name Description
value com.google.type.Date
Returns
Type Description
YoutubeProductPerformanceView.Builder

setDate(Date.Builder builderForValue)

public YoutubeProductPerformanceView.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
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
YoutubeProductPerformanceView.Builder

setDistinctCreatorCount(long value)

public YoutubeProductPerformanceView.Builder setDistinctCreatorCount(long value)

The number of distinct creator channels the product was shown on.

optional int64 distinct_creator_count = 5;

Parameter
Name Description
value long

The distinctCreatorCount to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setDistinctVideoCount(long value)

public YoutubeProductPerformanceView.Builder setDistinctVideoCount(long value)

The number of distinct videos the product was shown on.

optional int64 distinct_video_count = 4;

Parameter
Name Description
value long

The distinctVideoCount to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public YoutubeProductPerformanceView.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

setGrossSales(Price value)

public YoutubeProductPerformanceView.Builder setGrossSales(Price value)

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
YoutubeProductPerformanceView.Builder

setGrossSales(Price.Builder builderForValue)

public YoutubeProductPerformanceView.Builder setGrossSales(Price.Builder builderForValue)

The gross sales amount, before refunds.

optional .google.shopping.type.Price gross_sales = 6;

Parameter
Name Description
builderForValue com.google.shopping.type.Price.Builder
Returns
Type Description
YoutubeProductPerformanceView.Builder

setNetSales(Price value)

public YoutubeProductPerformanceView.Builder setNetSales(Price value)

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Parameter
Name Description
value com.google.shopping.type.Price
Returns
Type Description
YoutubeProductPerformanceView.Builder

setNetSales(Price.Builder builderForValue)

public YoutubeProductPerformanceView.Builder setNetSales(Price.Builder builderForValue)

The net sales amount (includes both purchase and refunds).

optional .google.shopping.type.Price net_sales = 11;

Parameter
Name Description
builderForValue com.google.shopping.type.Price.Builder
Returns
Type Description
YoutubeProductPerformanceView.Builder

setOfferId(String value)

public YoutubeProductPerformanceView.Builder setOfferId(String value)

The merchant-provided product id.

optional string offer_id = 3;

Parameter
Name Description
value String

The offerId to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setOfferIdBytes(ByteString value)

public YoutubeProductPerformanceView.Builder setOfferIdBytes(ByteString value)

The merchant-provided product id.

optional string offer_id = 3;

Parameter
Name Description
value ByteString

The bytes for offerId to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setOrders(long value)

public YoutubeProductPerformanceView.Builder setOrders(long value)

The number of orders.

optional int64 orders = 8;

Parameter
Name Description
value long

The orders to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

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

public YoutubeProductPerformanceView.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

setTitle(String value)

public YoutubeProductPerformanceView.Builder setTitle(String value)

The product title.

optional string title = 2;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public YoutubeProductPerformanceView.Builder setTitleBytes(ByteString value)

The product title.

optional string title = 2;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final YoutubeProductPerformanceView.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
YoutubeProductPerformanceView.Builder
Overrides

setViews(long value)

public YoutubeProductPerformanceView.Builder setViews(long value)

The number of YouTube views.

optional int64 views = 9;

Parameter
Name Description
value long

The views to set.

Returns
Type Description
YoutubeProductPerformanceView.Builder

This builder for chaining.