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

Class GenerateHistoricalMetricsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

GenerateHistoricalMetricsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class GenerateHistoricalMetricsRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateHistoricalMetricsRequestOrBuilder

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateHistoricalMetricsRequest.Builder	Request message for [KeywordPlanService.GenerateHistoricalMetrics][google.ads.googleads.v10.services.KeywordPlanService.GenerateHistoricalMetrics].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	AGGREGATE_METRICS_FIELD_NUMBER
static int	HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER
static int	KEYWORD_PLAN_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
KeywordPlanAggregateMetrics	getAggregateMetrics()	The aggregate fields to include in response.
KeywordPlanAggregateMetricsOrBuilder	getAggregateMetricsOrBuilder()	The aggregate fields to include in response.
static GenerateHistoricalMetricsRequest	getDefaultInstance()
GenerateHistoricalMetricsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
HistoricalMetricsOptions	getHistoricalMetricsOptions()	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.
com.google.protobuf.Parser<GenerateHistoricalMetricsRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAggregateMetrics()	The aggregate fields to include in response.
int	hashCode()
boolean	hasHistoricalMetricsOptions()	The options for historical metrics data.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateHistoricalMetricsRequest.Builder	newBuilder()
static GenerateHistoricalMetricsRequest.Builder	newBuilder(GenerateHistoricalMetricsRequest prototype)
GenerateHistoricalMetricsRequest.Builder	newBuilderForType()
protected GenerateHistoricalMetricsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateHistoricalMetricsRequest	parseDelimitedFrom(java.io.InputStream input)
static GenerateHistoricalMetricsRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateHistoricalMetricsRequest	parseFrom(byte[] data)
static GenerateHistoricalMetricsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateHistoricalMetricsRequest	parseFrom(com.google.protobuf.ByteString data)
static GenerateHistoricalMetricsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateHistoricalMetricsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateHistoricalMetricsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateHistoricalMetricsRequest	parseFrom(java.io.InputStream input)
static GenerateHistoricalMetricsRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateHistoricalMetricsRequest	parseFrom(java.nio.ByteBuffer data)
static GenerateHistoricalMetricsRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateHistoricalMetricsRequest>	parser()
GenerateHistoricalMetricsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

KEYWORD_PLAN_FIELD_NUMBER

public static final int KEYWORD_PLAN_FIELD_NUMBER

See Also:

Constant Field Values

AGGREGATE_METRICS_FIELD_NUMBER

public static final int AGGREGATE_METRICS_FIELD_NUMBER

See Also:

Constant Field Values

HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER

public static final int HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(java.nio.ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(java.nio.ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(java.io.InputStream input)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(java.io.InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static GenerateHistoricalMetricsRequest parseDelimitedFrom(java.io.InputStream input)
                                                           throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static GenerateHistoricalMetricsRequest parseDelimitedFrom(java.io.InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GenerateHistoricalMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public GenerateHistoricalMetricsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateHistoricalMetricsRequest.Builder newBuilder()

newBuilder

public static GenerateHistoricalMetricsRequest.Builder newBuilder(GenerateHistoricalMetricsRequest prototype)

toBuilder

public GenerateHistoricalMetricsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateHistoricalMetricsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateHistoricalMetricsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerateHistoricalMetricsRequest> parser()

getParserForType

public com.google.protobuf.Parser<GenerateHistoricalMetricsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GenerateHistoricalMetricsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder