Package com.google.ads.googleads.v10.services

Class GenerateHistoricalMetricsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

com.google.ads.googleads.v10.services.GenerateHistoricalMetricsRequest.Builder

All Implemented Interfaces:

GenerateHistoricalMetricsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

GenerateHistoricalMetricsRequest

public static final class GenerateHistoricalMetricsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>
implements GenerateHistoricalMetricsRequestOrBuilder

 Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v10.services.KeywordPlanService.GenerateHistoricalMetrics].
 

Protobuf type google.ads.googleads.v10.services.GenerateHistoricalMetricsRequest

Method Summary

Modifier and Type	Method	Description
GenerateHistoricalMetricsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
GenerateHistoricalMetricsRequest	build()
GenerateHistoricalMetricsRequest	buildPartial()
GenerateHistoricalMetricsRequest.Builder	clear()
GenerateHistoricalMetricsRequest.Builder	clearAggregateMetrics()	The aggregate fields to include in response.
GenerateHistoricalMetricsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
GenerateHistoricalMetricsRequest.Builder	clearHistoricalMetricsOptions()	The options for historical metrics data.
GenerateHistoricalMetricsRequest.Builder	clearKeywordPlan()	Required.
GenerateHistoricalMetricsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
GenerateHistoricalMetricsRequest.Builder	clone()
KeywordPlanAggregateMetrics	getAggregateMetrics()	The aggregate fields to include in response.
KeywordPlanAggregateMetrics.Builder	getAggregateMetricsBuilder()	The aggregate fields to include in response.
KeywordPlanAggregateMetricsOrBuilder	getAggregateMetricsOrBuilder()	The aggregate fields to include in response.
GenerateHistoricalMetricsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
HistoricalMetricsOptions	getHistoricalMetricsOptions()	The options for historical metrics data.
HistoricalMetricsOptions.Builder	getHistoricalMetricsOptionsBuilder()	The options for historical metrics data.
HistoricalMetricsOptionsOrBuilder	getHistoricalMetricsOptionsOrBuilder()	The options for historical metrics data.
java.lang.String	getKeywordPlan()	Required.
com.google.protobuf.ByteString	getKeywordPlanBytes()	Required.
boolean	hasAggregateMetrics()	The aggregate fields to include in response.
boolean	hasHistoricalMetricsOptions()	The options for historical metrics data.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GenerateHistoricalMetricsRequest.Builder	mergeAggregateMetrics(KeywordPlanAggregateMetrics value)	The aggregate fields to include in response.
GenerateHistoricalMetricsRequest.Builder	mergeFrom(GenerateHistoricalMetricsRequest other)
GenerateHistoricalMetricsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GenerateHistoricalMetricsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
GenerateHistoricalMetricsRequest.Builder	mergeHistoricalMetricsOptions(HistoricalMetricsOptions value)	The options for historical metrics data.
GenerateHistoricalMetricsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GenerateHistoricalMetricsRequest.Builder	setAggregateMetrics(KeywordPlanAggregateMetrics value)	The aggregate fields to include in response.
GenerateHistoricalMetricsRequest.Builder	setAggregateMetrics(KeywordPlanAggregateMetrics.Builder builderForValue)	The aggregate fields to include in response.
GenerateHistoricalMetricsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
GenerateHistoricalMetricsRequest.Builder	setHistoricalMetricsOptions(HistoricalMetricsOptions value)	The options for historical metrics data.
GenerateHistoricalMetricsRequest.Builder	setHistoricalMetricsOptions(HistoricalMetricsOptions.Builder builderForValue)	The options for historical metrics data.
GenerateHistoricalMetricsRequest.Builder	setKeywordPlan(java.lang.String value)	Required.
GenerateHistoricalMetricsRequest.Builder	setKeywordPlanBytes(com.google.protobuf.ByteString value)	Required.
GenerateHistoricalMetricsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
GenerateHistoricalMetricsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

clear

public GenerateHistoricalMetricsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

getDefaultInstanceForType

public GenerateHistoricalMetricsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GenerateHistoricalMetricsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GenerateHistoricalMetricsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public GenerateHistoricalMetricsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

setField

public GenerateHistoricalMetricsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

clearField

public GenerateHistoricalMetricsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

clearOneof

public GenerateHistoricalMetricsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

setRepeatedField

public GenerateHistoricalMetricsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 int index,
                                                                 java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

addRepeatedField

public GenerateHistoricalMetricsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

mergeFrom

public GenerateHistoricalMetricsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateHistoricalMetricsRequest.Builder>

mergeFrom

public GenerateHistoricalMetricsRequest.Builder mergeFrom(GenerateHistoricalMetricsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

mergeFrom

public GenerateHistoricalMetricsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateHistoricalMetricsRequest.Builder>

Throws:

java.io.IOException

getKeywordPlan

public java.lang.String getKeywordPlan()

 Required. The resource name of the keyword plan of which historical metrics are
 requested.
 

string keyword_plan = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getKeywordPlan in interface GenerateHistoricalMetricsRequestOrBuilder

Returns:

The keywordPlan.

getKeywordPlanBytes

public com.google.protobuf.ByteString getKeywordPlanBytes()

 Required. The resource name of the keyword plan of which historical metrics are
 requested.
 

string keyword_plan = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getKeywordPlanBytes in interface GenerateHistoricalMetricsRequestOrBuilder

Returns:

The bytes for keywordPlan.

setKeywordPlan

public GenerateHistoricalMetricsRequest.Builder setKeywordPlan(java.lang.String value)

 Required. The resource name of the keyword plan of which historical metrics are
 requested.
 

string keyword_plan = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The keywordPlan to set.

Returns:

This builder for chaining.

clearKeywordPlan

public GenerateHistoricalMetricsRequest.Builder clearKeywordPlan()

 Required. The resource name of the keyword plan of which historical metrics are
 requested.
 

string keyword_plan = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setKeywordPlanBytes

public GenerateHistoricalMetricsRequest.Builder setKeywordPlanBytes(com.google.protobuf.ByteString value)

 Required. The resource name of the keyword plan of which historical metrics are
 requested.
 

string keyword_plan = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for keywordPlan to set.

Returns:

This builder for chaining.

hasAggregateMetrics

public boolean hasAggregateMetrics()

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

Specified by:

hasAggregateMetrics in interface GenerateHistoricalMetricsRequestOrBuilder

Returns:

Whether the aggregateMetrics field is set.

getAggregateMetrics

public KeywordPlanAggregateMetrics getAggregateMetrics()

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

Specified by:

getAggregateMetrics in interface GenerateHistoricalMetricsRequestOrBuilder

Returns:

The aggregateMetrics.

setAggregateMetrics

public GenerateHistoricalMetricsRequest.Builder setAggregateMetrics(KeywordPlanAggregateMetrics value)

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

setAggregateMetrics

public GenerateHistoricalMetricsRequest.Builder setAggregateMetrics(KeywordPlanAggregateMetrics.Builder builderForValue)

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

mergeAggregateMetrics

public GenerateHistoricalMetricsRequest.Builder mergeAggregateMetrics(KeywordPlanAggregateMetrics value)

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

clearAggregateMetrics

public GenerateHistoricalMetricsRequest.Builder clearAggregateMetrics()

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

getAggregateMetricsBuilder

public KeywordPlanAggregateMetrics.Builder getAggregateMetricsBuilder()

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

getAggregateMetricsOrBuilder

public KeywordPlanAggregateMetricsOrBuilder getAggregateMetricsOrBuilder()

 The aggregate fields to include in response.
 

.google.ads.googleads.v10.common.KeywordPlanAggregateMetrics aggregate_metrics = 2;

Specified by:

getAggregateMetricsOrBuilder in interface GenerateHistoricalMetricsRequestOrBuilder

hasHistoricalMetricsOptions

public boolean hasHistoricalMetricsOptions()

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

Specified by:

hasHistoricalMetricsOptions in interface GenerateHistoricalMetricsRequestOrBuilder

Returns:

Whether the historicalMetricsOptions field is set.

getHistoricalMetricsOptions

public HistoricalMetricsOptions getHistoricalMetricsOptions()

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

Specified by:

getHistoricalMetricsOptions in interface GenerateHistoricalMetricsRequestOrBuilder

Returns:

The historicalMetricsOptions.

setHistoricalMetricsOptions

public GenerateHistoricalMetricsRequest.Builder setHistoricalMetricsOptions(HistoricalMetricsOptions value)

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

setHistoricalMetricsOptions

public GenerateHistoricalMetricsRequest.Builder setHistoricalMetricsOptions(HistoricalMetricsOptions.Builder builderForValue)

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

mergeHistoricalMetricsOptions

public GenerateHistoricalMetricsRequest.Builder mergeHistoricalMetricsOptions(HistoricalMetricsOptions value)

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

clearHistoricalMetricsOptions

public GenerateHistoricalMetricsRequest.Builder clearHistoricalMetricsOptions()

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

getHistoricalMetricsOptionsBuilder

public HistoricalMetricsOptions.Builder getHistoricalMetricsOptionsBuilder()

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

getHistoricalMetricsOptionsOrBuilder

public HistoricalMetricsOptionsOrBuilder getHistoricalMetricsOptionsOrBuilder()

 The options for historical metrics data.
 

.google.ads.googleads.v10.common.HistoricalMetricsOptions historical_metrics_options = 3;

Specified by:

getHistoricalMetricsOptionsOrBuilder in interface GenerateHistoricalMetricsRequestOrBuilder

setUnknownFields

public final GenerateHistoricalMetricsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>

mergeUnknownFields

public final GenerateHistoricalMetricsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateHistoricalMetricsRequest.Builder>