Package com.google.ads.googleads.v15.services

Class GenerateAudienceCompositionInsightsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.ads.googleads.v15.services.GenerateAudienceCompositionInsightsRequest

All Implemented Interfaces:

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

public final class GenerateAudienceCompositionInsightsRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateAudienceCompositionInsightsRequestOrBuilder

 Request message for
 [AudienceInsightsService.GenerateAudienceCompositionInsights][google.ads.googleads.v15.services.AudienceInsightsService.GenerateAudienceCompositionInsights].
 

Protobuf type google.ads.googleads.v15.services.GenerateAudienceCompositionInsightsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateAudienceCompositionInsightsRequest.Builder	Request message for [AudienceInsightsService.GenerateAudienceCompositionInsights][google.ads.googleads.v15.services.AudienceInsightsService.GenerateAudienceCompositionInsights].

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

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	AUDIENCE_FIELD_NUMBER
static int	BASELINE_AUDIENCE_FIELD_NUMBER
static int	CUSTOMER_ID_FIELD_NUMBER
static int	CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER
static int	DATA_MONTH_FIELD_NUMBER
static int	DIMENSIONS_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)
InsightsAudience	getAudience()	Required.
InsightsAudienceOrBuilder	getAudienceOrBuilder()	Required.
InsightsAudience	getBaselineAudience()	The baseline audience to which the audience of interest is being compared.
InsightsAudienceOrBuilder	getBaselineAudienceOrBuilder()	The baseline audience to which the audience of interest is being compared.
java.lang.String	getCustomerId()	Required.
com.google.protobuf.ByteString	getCustomerIdBytes()	Required.
java.lang.String	getCustomerInsightsGroup()	The name of the customer being planned for.
com.google.protobuf.ByteString	getCustomerInsightsGroupBytes()	The name of the customer being planned for.
java.lang.String	getDataMonth()	The one-month range of historical data to use for insights, in the format "yyyy-mm".
com.google.protobuf.ByteString	getDataMonthBytes()	The one-month range of historical data to use for insights, in the format "yyyy-mm".
static GenerateAudienceCompositionInsightsRequest	getDefaultInstance()
GenerateAudienceCompositionInsightsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
AudienceInsightsDimensionEnum.AudienceInsightsDimension	getDimensions(int index)	Required.
int	getDimensionsCount()	Required.
java.util.List<AudienceInsightsDimensionEnum.AudienceInsightsDimension>	getDimensionsList()	Required.
int	getDimensionsValue(int index)	Required.
java.util.List<java.lang.Integer>	getDimensionsValueList()	Required.
com.google.protobuf.Parser<GenerateAudienceCompositionInsightsRequest>	getParserForType()
int	getSerializedSize()
boolean	hasAudience()	Required.
boolean	hasBaselineAudience()	The baseline audience to which the audience of interest is being compared.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateAudienceCompositionInsightsRequest.Builder	newBuilder()
static GenerateAudienceCompositionInsightsRequest.Builder	newBuilder(GenerateAudienceCompositionInsightsRequest prototype)
GenerateAudienceCompositionInsightsRequest.Builder	newBuilderForType()
protected GenerateAudienceCompositionInsightsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected java.lang.Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateAudienceCompositionInsightsRequest	parseDelimitedFrom(java.io.InputStream input)
static GenerateAudienceCompositionInsightsRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateAudienceCompositionInsightsRequest	parseFrom(byte[] data)
static GenerateAudienceCompositionInsightsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateAudienceCompositionInsightsRequest	parseFrom(com.google.protobuf.ByteString data)
static GenerateAudienceCompositionInsightsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateAudienceCompositionInsightsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateAudienceCompositionInsightsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateAudienceCompositionInsightsRequest	parseFrom(java.io.InputStream input)
static GenerateAudienceCompositionInsightsRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateAudienceCompositionInsightsRequest	parseFrom(java.nio.ByteBuffer data)
static GenerateAudienceCompositionInsightsRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateAudienceCompositionInsightsRequest>	parser()
GenerateAudienceCompositionInsightsRequest.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

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, getUnknownFields, hasField, hasOneof

Field Detail

CUSTOMER_ID_FIELD_NUMBER

public static final int CUSTOMER_ID_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCE_FIELD_NUMBER

public static final int AUDIENCE_FIELD_NUMBER

See Also:

Constant Field Values

BASELINE_AUDIENCE_FIELD_NUMBER

public static final int BASELINE_AUDIENCE_FIELD_NUMBER

See Also:

Constant Field Values

DATA_MONTH_FIELD_NUMBER

public static final int DATA_MONTH_FIELD_NUMBER

See Also:

Constant Field Values

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOMER_INSIGHTS_GROUP_FIELD_NUMBER

public static final int CUSTOMER_INSIGHTS_GROUP_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

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

getCustomerId

public java.lang.String getCustomerId()

 Required. The ID of the customer.
 

string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getCustomerId in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The customerId.

getCustomerIdBytes

public com.google.protobuf.ByteString getCustomerIdBytes()

 Required. The ID of the customer.
 

string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getCustomerIdBytes in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The bytes for customerId.

hasAudience

public boolean hasAudience()

 Required. The audience of interest for which insights are being requested.
 

.google.ads.googleads.v15.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasAudience in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

Whether the audience field is set.

getAudience

public InsightsAudience getAudience()

 Required. The audience of interest for which insights are being requested.
 

.google.ads.googleads.v15.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getAudience in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The audience.

getAudienceOrBuilder

public InsightsAudienceOrBuilder getAudienceOrBuilder()

 Required. The audience of interest for which insights are being requested.
 

.google.ads.googleads.v15.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getAudienceOrBuilder in interface GenerateAudienceCompositionInsightsRequestOrBuilder

hasBaselineAudience

public boolean hasBaselineAudience()

 The baseline audience to which the audience of interest is being
 compared.
 

.google.ads.googleads.v15.services.InsightsAudience baseline_audience = 6;

Specified by:

hasBaselineAudience in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

Whether the baselineAudience field is set.

getBaselineAudience

public InsightsAudience getBaselineAudience()

 The baseline audience to which the audience of interest is being
 compared.
 

.google.ads.googleads.v15.services.InsightsAudience baseline_audience = 6;

Specified by:

getBaselineAudience in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The baselineAudience.

getBaselineAudienceOrBuilder

public InsightsAudienceOrBuilder getBaselineAudienceOrBuilder()

 The baseline audience to which the audience of interest is being
 compared.
 

.google.ads.googleads.v15.services.InsightsAudience baseline_audience = 6;

Specified by:

getBaselineAudienceOrBuilder in interface GenerateAudienceCompositionInsightsRequestOrBuilder

getDataMonth

public java.lang.String getDataMonth()

 The one-month range of historical data to use for insights, in the format
 "yyyy-mm". If unset, insights will be returned for the last thirty days of
 data.
 

string data_month = 3;

Specified by:

getDataMonth in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The dataMonth.

getDataMonthBytes

public com.google.protobuf.ByteString getDataMonthBytes()

 The one-month range of historical data to use for insights, in the format
 "yyyy-mm". If unset, insights will be returned for the last thirty days of
 data.
 

string data_month = 3;

Specified by:

getDataMonthBytes in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The bytes for dataMonth.

getDimensionsList

public java.util.List<AudienceInsightsDimensionEnum.AudienceInsightsDimension> getDimensionsList()

 Required. The audience dimensions for which composition insights should be
 returned.
 

repeated .google.ads.googleads.v15.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsList in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

A list containing the dimensions.

getDimensionsCount

public int getDimensionsCount()

 Required. The audience dimensions for which composition insights should be
 returned.
 

repeated .google.ads.googleads.v15.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsCount in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The count of dimensions.

getDimensions

public AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimensions(int index)

 Required. The audience dimensions for which composition insights should be
 returned.
 

repeated .google.ads.googleads.v15.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensions in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The dimensions at the given index.

getDimensionsValueList

public java.util.List<java.lang.Integer> getDimensionsValueList()

 Required. The audience dimensions for which composition insights should be
 returned.
 

repeated .google.ads.googleads.v15.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsValueList in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

A list containing the enum numeric values on the wire for dimensions.

getDimensionsValue

public int getDimensionsValue(int index)

 Required. The audience dimensions for which composition insights should be
 returned.
 

repeated .google.ads.googleads.v15.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDimensionsValue in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of dimensions at the given index.

getCustomerInsightsGroup

public java.lang.String getCustomerInsightsGroup()

 The name of the customer being planned for.  This is a user-defined value.
 

string customer_insights_group = 5;

Specified by:

getCustomerInsightsGroup in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The customerInsightsGroup.

getCustomerInsightsGroupBytes

public com.google.protobuf.ByteString getCustomerInsightsGroupBytes()

 The name of the customer being planned for.  This is a user-defined value.
 

string customer_insights_group = 5;

Specified by:

getCustomerInsightsGroupBytes in interface GenerateAudienceCompositionInsightsRequestOrBuilder

Returns:

The bytes for customerInsightsGroup.

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 GenerateAudienceCompositionInsightsRequest parseFrom(java.nio.ByteBuffer data)
                                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public GenerateAudienceCompositionInsightsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateAudienceCompositionInsightsRequest.Builder newBuilder()

newBuilder

public static GenerateAudienceCompositionInsightsRequest.Builder newBuilder(GenerateAudienceCompositionInsightsRequest prototype)

toBuilder

public GenerateAudienceCompositionInsightsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateAudienceCompositionInsightsRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<GenerateAudienceCompositionInsightsRequest> 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 GenerateAudienceCompositionInsightsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder