Package com.google.ads.googleads.v25.services

Interface GenerateBenchmarksMetricsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateBenchmarksMetricsRequest, GenerateBenchmarksMetricsRequest.Builder
@Generated public interface GenerateBenchmarksMetricsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

      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];
      Returns:
      The customerId.

    • getCustomerIdBytes

      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];
      Returns:
      The bytes for customerId.

    • hasDateRange

      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.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
      .google.ads.googleads.v25.common.DateRange date_range = 2;
      Returns:
      Whether the dateRange field is set.

    • getDateRange

      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.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
      .google.ads.googleads.v25.common.DateRange date_range = 2;
      Returns:
      The dateRange.

    • getDateRangeOrBuilder

      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.v25.services.BenchmarksService.ListBenchmarksAvailableDates].
      .google.ads.googleads.v25.common.DateRange date_range = 2;

    • hasLocation

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

    • getLocation

      LocationInfo getLocation()
       Required. The location to generate benchmarks metrics for.
      .google.ads.googleads.v25.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The location.

    • getLocationOrBuilder

      LocationInfoOrBuilder getLocationOrBuilder()
       Required. The location to generate benchmarks metrics for.
      .google.ads.googleads.v25.common.LocationInfo location = 3 [(.google.api.field_behavior) = REQUIRED];

    • hasBenchmarksSource

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

    • getBenchmarksSource

      BenchmarksSource getBenchmarksSource()
       Required. The source used to generate benchmarks metrics for.
      .google.ads.googleads.v25.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The benchmarksSource.

    • getBenchmarksSourceOrBuilder

      BenchmarksSourceOrBuilder getBenchmarksSourceOrBuilder()
       Required. The source used to generate benchmarks metrics for.
      .google.ads.googleads.v25.services.BenchmarksSource benchmarks_source = 4 [(.google.api.field_behavior) = REQUIRED];

    • hasCategoryFilter

      boolean hasCategoryFilter()
       A list of Product & Service Categories for scoping a YouTube benchmarks
 analysis. For example, when category "/Apparel/Clothing" is selected,
 customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
 and the customer is benchmarking against all advertisers’ Ads in the
 "/Apparel/Clothing" category.

 This filter can only be used when `all_advertisers` is used as the
 [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
      .google.ads.googleads.v25.services.CategoryFilter category_filter = 10;
      Returns:
      Whether the categoryFilter field is set.

    • getCategoryFilter

      CategoryFilter getCategoryFilter()
       A list of Product & Service Categories for scoping a YouTube benchmarks
 analysis. For example, when category "/Apparel/Clothing" is selected,
 customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
 and the customer is benchmarking against all advertisers’ Ads in the
 "/Apparel/Clothing" category.

 This filter can only be used when `all_advertisers` is used as the
 [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
      .google.ads.googleads.v25.services.CategoryFilter category_filter = 10;
      Returns:
      The categoryFilter.

    • getCategoryFilterOrBuilder

      CategoryFilterOrBuilder getCategoryFilterOrBuilder()
       A list of Product & Service Categories for scoping a YouTube benchmarks
 analysis. For example, when category "/Apparel/Clothing" is selected,
 customer metrics represent Ad performance for "/Apparel/Clothing" Ads only
 and the customer is benchmarking against all advertisers’ Ads in the
 "/Apparel/Clothing" category.

 This filter can only be used when `all_advertisers` is used as the
 [benchmarks_source][google.ads.googleads.v25.services.GenerateBenchmarksMetricsRequest.benchmarks_source].
      .google.ads.googleads.v25.services.CategoryFilter category_filter = 10;

    • hasProductFilter

      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.v25.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the productFilter field is set.

    • getProductFilter

      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.v25.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The productFilter.

    • getProductFilterOrBuilder

      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.v25.services.ProductFilter product_filter = 5 [(.google.api.field_behavior) = REQUIRED];

    • hasBreakdownDefinition

      boolean hasBreakdownDefinition()
       Optional. The set of dimensions to group metrics by. If multiple dimensions
 are selected, cross-dimension breakdowns are returned.
      .google.ads.googleads.v25.services.BreakdownDefinition breakdown_definition = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the breakdownDefinition field is set.

    • getBreakdownDefinition

      BreakdownDefinition getBreakdownDefinition()
       Optional. The set of dimensions to group metrics by. If multiple dimensions
 are selected, cross-dimension breakdowns are returned.
      .google.ads.googleads.v25.services.BreakdownDefinition breakdown_definition = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The breakdownDefinition.

    • getBreakdownDefinitionOrBuilder

      BreakdownDefinitionOrBuilder getBreakdownDefinitionOrBuilder()
       Optional. The set of dimensions to group metrics by. If multiple dimensions
 are selected, cross-dimension breakdowns are returned.
      .google.ads.googleads.v25.services.BreakdownDefinition breakdown_definition = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getCurrencyCode

      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];
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      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];
      Returns:
      The bytes for currencyCode.

    • getCustomerBenchmarksGroup

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

    • getCustomerBenchmarksGroupBytes

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

    • hasApplicationInfo

      boolean hasApplicationInfo()
       Additional information on the application issuing the request.
      .google.ads.googleads.v25.common.AdditionalApplicationInfo application_info = 8;
      Returns:
      Whether the applicationInfo field is set.

    • getApplicationInfo

      AdditionalApplicationInfo getApplicationInfo()
       Additional information on the application issuing the request.
      .google.ads.googleads.v25.common.AdditionalApplicationInfo application_info = 8;
      Returns:
      The applicationInfo.

    • getApplicationInfoOrBuilder

      AdditionalApplicationInfoOrBuilder getApplicationInfoOrBuilder()
       Additional information on the application issuing the request.
      .google.ads.googleads.v25.common.AdditionalApplicationInfo application_info = 8;