com.google.ads.googleads.v17.services.GenerateAudienceCompositionInsightsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/audience_insights_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface GenerateAudienceCompositionInsightsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.GenerateAudienceCompositionInsightsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Required. The ID of the customer.
   * 
   *
   * string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The customerId.
   */
  java.lang.String getCustomerId();
  /**
   *    * Required. The ID of the customer.
   * 
   *
   * string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for customerId.
   */
  com.google.protobuf.ByteString
      getCustomerIdBytes();

  /**
   *    * Required. The audience of interest for which insights are being requested.
   * 
   *
   * .google.ads.googleads.v17.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return Whether the audience field is set.
   */
  boolean hasAudience();
  /**
   *    * Required. The audience of interest for which insights are being requested.
   * 
   *
   * .google.ads.googleads.v17.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return The audience.
   */
  com.google.ads.googleads.v17.services.InsightsAudience getAudience();
  /**
   *    * Required. The audience of interest for which insights are being requested.
   * 
   *
   * .google.ads.googleads.v17.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.InsightsAudienceOrBuilder getAudienceOrBuilder();

  /**
   *    * The baseline audience to which the audience of interest is being
   * compared.
   * 
   *
   * .google.ads.googleads.v17.services.InsightsAudience baseline_audience = 6;
   * @return Whether the baselineAudience field is set.
   */
  boolean hasBaselineAudience();
  /**
   *    * The baseline audience to which the audience of interest is being
   * compared.
   * 
   *
   * .google.ads.googleads.v17.services.InsightsAudience baseline_audience = 6;
   * @return The baselineAudience.
   */
  com.google.ads.googleads.v17.services.InsightsAudience getBaselineAudience();
  /**
   *    * The baseline audience to which the audience of interest is being
   * compared.
   * 
   *
   * .google.ads.googleads.v17.services.InsightsAudience baseline_audience = 6;
   */
  com.google.ads.googleads.v17.services.InsightsAudienceOrBuilder getBaselineAudienceOrBuilder();

  /**
   *    * 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;
   * @return The dataMonth.
   */
  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;
   * @return The bytes for dataMonth.
   */
  com.google.protobuf.ByteString
      getDataMonthBytes();

  /**
   *    * Required. The audience dimensions for which composition insights should be
   * returned.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return A list containing the dimensions.
   */
  java.util.List getDimensionsList();
  /**
   *    * Required. The audience dimensions for which composition insights should be
   * returned.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return The count of dimensions.
   */
  int getDimensionsCount();
  /**
   *    * Required. The audience dimensions for which composition insights should be
   * returned.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @param index The index of the element to return.
   * @return The dimensions at the given index.
   */
  com.google.ads.googleads.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimensions(int index);
  /**
   *    * Required. The audience dimensions for which composition insights should be
   * returned.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return A list containing the enum numeric values on the wire for dimensions.
   */
  java.util.List
  getDimensionsValueList();
  /**
   *    * Required. The audience dimensions for which composition insights should be
   * returned.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of dimensions at the given index.
   */
  int getDimensionsValue(int index);

  /**
   *    * The name of the customer being planned for.  This is a user-defined value.
   * 
   *
   * string customer_insights_group = 5;
   * @return The customerInsightsGroup.
   */
  java.lang.String getCustomerInsightsGroup();
  /**
   *    * The name of the customer being planned for.  This is a user-defined value.
   * 
   *
   * string customer_insights_group = 5;
   * @return The bytes for customerInsightsGroup.
   */
  com.google.protobuf.ByteString
      getCustomerInsightsGroupBytes();
}