Class GenerateKeywordForecastMetricsRequest
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.ads.googleads.v14.services.GenerateKeywordForecastMetricsRequest
-
- All Implemented Interfaces:
GenerateKeywordForecastMetricsRequestOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.io.Serializable
public final class GenerateKeywordForecastMetricsRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateKeywordForecastMetricsRequestOrBuilder
Request message for [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].
Protobuf typegoogle.ads.googleads.v14.services.GenerateKeywordForecastMetricsRequest
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GenerateKeywordForecastMetricsRequest.Builder
Request message for [KeywordPlanIdeaService.GenerateKeywordForecastMetrics].-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
CAMPAIGN_FIELD_NUMBER
static int
CURRENCY_CODE_FIELD_NUMBER
static int
CUSTOMER_ID_FIELD_NUMBER
static int
FORECAST_PERIOD_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
CampaignToForecast
getCampaign()
Required.CampaignToForecastOrBuilder
getCampaignOrBuilder()
Required.java.lang.String
getCurrencyCode()
The currency used for exchange rate conversion.com.google.protobuf.ByteString
getCurrencyCodeBytes()
The currency used for exchange rate conversion.java.lang.String
getCustomerId()
The ID of the customer.com.google.protobuf.ByteString
getCustomerIdBytes()
The ID of the customer.static GenerateKeywordForecastMetricsRequest
getDefaultInstance()
GenerateKeywordForecastMetricsRequest
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
DateRange
getForecastPeriod()
The date range for the forecast.DateRangeOrBuilder
getForecastPeriodOrBuilder()
The date range for the forecast.com.google.protobuf.Parser<GenerateKeywordForecastMetricsRequest>
getParserForType()
int
getSerializedSize()
boolean
hasCampaign()
Required.boolean
hasCurrencyCode()
The currency used for exchange rate conversion.boolean
hasForecastPeriod()
The date range for the forecast.int
hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static GenerateKeywordForecastMetricsRequest.Builder
newBuilder()
static GenerateKeywordForecastMetricsRequest.Builder
newBuilder(GenerateKeywordForecastMetricsRequest prototype)
GenerateKeywordForecastMetricsRequest.Builder
newBuilderForType()
protected GenerateKeywordForecastMetricsRequest.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateKeywordForecastMetricsRequest
parseDelimitedFrom(java.io.InputStream input)
static GenerateKeywordForecastMetricsRequest
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateKeywordForecastMetricsRequest
parseFrom(byte[] data)
static GenerateKeywordForecastMetricsRequest
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateKeywordForecastMetricsRequest
parseFrom(com.google.protobuf.ByteString data)
static GenerateKeywordForecastMetricsRequest
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateKeywordForecastMetricsRequest
parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateKeywordForecastMetricsRequest
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateKeywordForecastMetricsRequest
parseFrom(java.io.InputStream input)
static GenerateKeywordForecastMetricsRequest
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateKeywordForecastMetricsRequest
parseFrom(java.nio.ByteBuffer data)
static GenerateKeywordForecastMetricsRequest
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateKeywordForecastMetricsRequest>
parser()
GenerateKeywordForecastMetricsRequest.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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
-
-
-
-
Field Detail
-
CUSTOMER_ID_FIELD_NUMBER
public static final int CUSTOMER_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CURRENCY_CODE_FIELD_NUMBER
public static final int CURRENCY_CODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FORECAST_PERIOD_FIELD_NUMBER
public static final int FORECAST_PERIOD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CAMPAIGN_FIELD_NUMBER
public static final int CAMPAIGN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
getCustomerId
public java.lang.String getCustomerId()
The ID of the customer.
string customer_id = 1;
- Specified by:
getCustomerId
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- The customerId.
-
getCustomerIdBytes
public com.google.protobuf.ByteString getCustomerIdBytes()
The ID of the customer.
string customer_id = 1;
- Specified by:
getCustomerIdBytes
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- The bytes for customerId.
-
hasCurrencyCode
public boolean hasCurrencyCode()
The currency used for exchange rate conversion. By default, the account currency of the customer is used. Set this field only if the currency is different from the account currency. The list of valid currency codes can be found at https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
optional string currency_code = 2;
- Specified by:
hasCurrencyCode
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- Whether the currencyCode field is set.
-
getCurrencyCode
public java.lang.String getCurrencyCode()
The currency used for exchange rate conversion. By default, the account currency of the customer is used. Set this field only if the currency is different from the account currency. The list of valid currency codes can be found at https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
optional string currency_code = 2;
- Specified by:
getCurrencyCode
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- The currencyCode.
-
getCurrencyCodeBytes
public com.google.protobuf.ByteString getCurrencyCodeBytes()
The currency used for exchange rate conversion. By default, the account currency of the customer is used. Set this field only if the currency is different from the account currency. The list of valid currency codes can be found at https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
optional string currency_code = 2;
- Specified by:
getCurrencyCodeBytes
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- The bytes for currencyCode.
-
hasForecastPeriod
public boolean hasForecastPeriod()
The date range for the forecast. The start date must be in the future and end date must be within 1 year from today. The reference timezone used is the one of the Google Ads account belonging to the customer. If not set, a default date range from next Sunday to the following Saturday will be used.
.google.ads.googleads.v14.common.DateRange forecast_period = 3;
- Specified by:
hasForecastPeriod
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- Whether the forecastPeriod field is set.
-
getForecastPeriod
public DateRange getForecastPeriod()
The date range for the forecast. The start date must be in the future and end date must be within 1 year from today. The reference timezone used is the one of the Google Ads account belonging to the customer. If not set, a default date range from next Sunday to the following Saturday will be used.
.google.ads.googleads.v14.common.DateRange forecast_period = 3;
- Specified by:
getForecastPeriod
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- The forecastPeriod.
-
getForecastPeriodOrBuilder
public DateRangeOrBuilder getForecastPeriodOrBuilder()
The date range for the forecast. The start date must be in the future and end date must be within 1 year from today. The reference timezone used is the one of the Google Ads account belonging to the customer. If not set, a default date range from next Sunday to the following Saturday will be used.
.google.ads.googleads.v14.common.DateRange forecast_period = 3;
- Specified by:
getForecastPeriodOrBuilder
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
-
hasCampaign
public boolean hasCampaign()
Required. The campaign used in the forecast.
.google.ads.googleads.v14.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
hasCampaign
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- Whether the campaign field is set.
-
getCampaign
public CampaignToForecast getCampaign()
Required. The campaign used in the forecast.
.google.ads.googleads.v14.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getCampaign
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
- Returns:
- The campaign.
-
getCampaignOrBuilder
public CampaignToForecastOrBuilder getCampaignOrBuilder()
Required. The campaign used in the forecast.
.google.ads.googleads.v14.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getCampaignOrBuilder
in interfaceGenerateKeywordForecastMetricsRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static GenerateKeywordForecastMetricsRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static GenerateKeywordForecastMetricsRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static GenerateKeywordForecastMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public GenerateKeywordForecastMetricsRequest.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static GenerateKeywordForecastMetricsRequest.Builder newBuilder()
-
newBuilder
public static GenerateKeywordForecastMetricsRequest.Builder newBuilder(GenerateKeywordForecastMetricsRequest prototype)
-
toBuilder
public GenerateKeywordForecastMetricsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected GenerateKeywordForecastMetricsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static GenerateKeywordForecastMetricsRequest getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<GenerateKeywordForecastMetricsRequest> parser()
-
getParserForType
public com.google.protobuf.Parser<GenerateKeywordForecastMetricsRequest> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public GenerateKeywordForecastMetricsRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-