Package com.google.ads.googleads.v23.services

Class GenerateBenchmarksMetricsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v23.services.GenerateBenchmarksMetricsRequest
All Implemented Interfaces:
GenerateBenchmarksMetricsRequestOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateBenchmarksMetricsRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateBenchmarksMetricsRequestOrBuilder
 Request message for
 [BenchmarksService.GenerateBenchmarksMetrics][google.ads.googleads.v23.services.BenchmarksService.GenerateBenchmarksMetrics].
Protobuf type google.ads.googleads.v23.services.GenerateBenchmarksMetricsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • DATE_RANGE_FIELD_NUMBER

      public static final int DATE_RANGE_FIELD_NUMBER
      See Also:

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

    • BENCHMARKS_SOURCE_FIELD_NUMBER

      public static final int BENCHMARKS_SOURCE_FIELD_NUMBER
      See Also:

    • PRODUCT_FILTER_FIELD_NUMBER

      public static final int PRODUCT_FILTER_FIELD_NUMBER
      See Also:

    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:

    • CUSTOMER_BENCHMARKS_GROUP_FIELD_NUMBER

      public static final int CUSTOMER_BENCHMARKS_GROUP_FIELD_NUMBER
      See Also:

    • APPLICATION_INFO_FIELD_NUMBER

      public static final int APPLICATION_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCustomerId

      public String getCustomerId()
       Required. The ID of the customer. Supply a client customer ID to generate
 metrics for the customer. A manager account customer ID will not return
 customer metrics since it does not have any associated direct ad campaigns.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer. Supply a client customer ID to generate
 metrics for the customer. A manager account customer ID will not return
 customer metrics since it does not have any associated direct ad campaigns.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerIdBytes in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The bytes for customerId.

    • hasDateRange

      public boolean hasDateRange()
       The date range to aggregate metrics over. If unset, data will be returned
 for the most recent quarter for which data is available. Dates can be
 retrieved using
 [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v23.services.BenchmarksService.ListBenchmarksAvailableDates].
      .google.ads.googleads.v23.common.DateRange date_range = 2;
      Specified by:
      hasDateRange in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      Whether the dateRange field is set.

    • getDateRange

      public DateRange getDateRange()
       The date range to aggregate metrics over. If unset, data will be returned
 for the most recent quarter for which data is available. Dates can be
 retrieved using
 [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v23.services.BenchmarksService.ListBenchmarksAvailableDates].
      .google.ads.googleads.v23.common.DateRange date_range = 2;
      Specified by:
      getDateRange in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The dateRange.

    • getDateRangeOrBuilder

      public DateRangeOrBuilder getDateRangeOrBuilder()
       The date range to aggregate metrics over. If unset, data will be returned
 for the most recent quarter for which data is available. Dates can be
 retrieved using
 [BenchmarksService.ListBenchmarksAvailableDates][google.ads.googleads.v23.services.BenchmarksService.ListBenchmarksAvailableDates].
      .google.ads.googleads.v23.common.DateRange date_range = 2;
      Specified by:
      getDateRangeOrBuilder in interface GenerateBenchmarksMetricsRequestOrBuilder

    • hasLocation

      public boolean hasLocation()
       Required. The location to generate benchmarks metrics for.
      .google.ads.googleads.v23.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasLocation in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      Whether the location field is set.

    • getLocation

      public LocationInfo getLocation()
       Required. The location to generate benchmarks metrics for.
      .google.ads.googleads.v23.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLocation in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The location.

    • getLocationOrBuilder

      public LocationInfoOrBuilder getLocationOrBuilder()
       Required. The location to generate benchmarks metrics for.
      .google.ads.googleads.v23.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLocationOrBuilder in interface GenerateBenchmarksMetricsRequestOrBuilder

    • hasBenchmarksSource

      public boolean hasBenchmarksSource()
       Required. The source used to generate benchmarks metrics for.
      .google.ads.googleads.v23.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasBenchmarksSource in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      Whether the benchmarksSource field is set.

    • getBenchmarksSource

      public BenchmarksSource getBenchmarksSource()
       Required. The source used to generate benchmarks metrics for.
      .google.ads.googleads.v23.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBenchmarksSource in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The benchmarksSource.

    • getBenchmarksSourceOrBuilder

      public BenchmarksSourceOrBuilder getBenchmarksSourceOrBuilder()
       Required. The source used to generate benchmarks metrics for.
      .google.ads.googleads.v23.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBenchmarksSourceOrBuilder in interface GenerateBenchmarksMetricsRequestOrBuilder

    • hasProductFilter

      public boolean hasProductFilter()
       Required. The products to aggregate metrics over. Product filter settings
 support a list of product IDs or a list of marketing objectives.
      .google.ads.googleads.v23.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasProductFilter in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      Whether the productFilter field is set.

    • getProductFilter

      public ProductFilter getProductFilter()
       Required. The products to aggregate metrics over. Product filter settings
 support a list of product IDs or a list of marketing objectives.
      .google.ads.googleads.v23.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProductFilter in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The productFilter.

    • getProductFilterOrBuilder

      public ProductFilterOrBuilder getProductFilterOrBuilder()
       Required. The products to aggregate metrics over. Product filter settings
 support a list of product IDs or a list of marketing objectives.
      .google.ads.googleads.v23.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProductFilterOrBuilder in interface GenerateBenchmarksMetricsRequestOrBuilder

    • getCurrencyCode

      public String getCurrencyCode()
       Optional. The three-character ISO 4217 currency code. If unspecified, the
 default currency for monetary values is USD.
      string currency_code = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCurrencyCode in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      public com.google.protobuf.ByteString getCurrencyCodeBytes()
       Optional. The three-character ISO 4217 currency code. If unspecified, the
 default currency for monetary values is USD.
      string currency_code = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCurrencyCodeBytes in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The bytes for currencyCode.

    • getCustomerBenchmarksGroup

      public String getCustomerBenchmarksGroup()
       The name of the customer being planned for. This is a user-defined value.
      string customer_benchmarks_group = 7;
      Specified by:
      getCustomerBenchmarksGroup in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The customerBenchmarksGroup.

    • getCustomerBenchmarksGroupBytes

      public com.google.protobuf.ByteString getCustomerBenchmarksGroupBytes()
       The name of the customer being planned for. This is a user-defined value.
      string customer_benchmarks_group = 7;
      Specified by:
      getCustomerBenchmarksGroupBytes in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The bytes for customerBenchmarksGroup.

    • hasApplicationInfo

      public boolean hasApplicationInfo()
       Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo application_info = 8;
      Specified by:
      hasApplicationInfo in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      Whether the applicationInfo field is set.

    • getApplicationInfo

      public AdditionalApplicationInfo getApplicationInfo()
       Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo application_info = 8;
      Specified by:
      getApplicationInfo in interface GenerateBenchmarksMetricsRequestOrBuilder
      Returns:
      The applicationInfo.

    • getApplicationInfoOrBuilder

      public AdditionalApplicationInfoOrBuilder getApplicationInfoOrBuilder()
       Additional information on the application issuing the request.
      .google.ads.googleads.v23.common.AdditionalApplicationInfo application_info = 8;
      Specified by:
      getApplicationInfoOrBuilder in interface GenerateBenchmarksMetricsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(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 GenerateBenchmarksMetricsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateBenchmarksMetricsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerateBenchmarksMetricsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerateBenchmarksMetricsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GenerateBenchmarksMetricsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GenerateBenchmarksMetricsRequest.Builder newBuilder()

    • newBuilder

      public static GenerateBenchmarksMetricsRequest.Builder newBuilder(GenerateBenchmarksMetricsRequest prototype)

    • toBuilder

      public GenerateBenchmarksMetricsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GenerateBenchmarksMetricsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static GenerateBenchmarksMetricsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GenerateBenchmarksMetricsRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

      public GenerateBenchmarksMetricsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder