Package com.google.ads.googleads.v14.services

Interface GenerateAudienceCompositionInsightsRequestOrBuilder

    • Method Detail

      • getCustomerId

        java.lang.String getCustomerId()
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The customerId.

      • getCustomerIdBytes

        com.google.protobuf.ByteString getCustomerIdBytes()
         Required. The ID of the customer.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for customerId.

      • hasAudience

        boolean hasAudience()
         Required. The audience of interest for which insights are being requested.
        .google.ads.googleads.v14.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the audience field is set.

      • getAudience

        InsightsAudience getAudience()
         Required. The audience of interest for which insights are being requested.
        .google.ads.googleads.v14.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The audience.

      • getAudienceOrBuilder

        InsightsAudienceOrBuilder getAudienceOrBuilder()
         Required. The audience of interest for which insights are being requested.
        .google.ads.googleads.v14.services.InsightsAudience audience = 2 [(.google.api.field_behavior) = REQUIRED];

      • hasBaselineAudience

        boolean hasBaselineAudience()
         The baseline audience to which the audience of interest is being
 compared.
        .google.ads.googleads.v14.services.InsightsAudience baseline_audience = 6;
        Returns:
        Whether the baselineAudience field is set.

      • getBaselineAudience

        InsightsAudience getBaselineAudience()
         The baseline audience to which the audience of interest is being
 compared.
        .google.ads.googleads.v14.services.InsightsAudience baseline_audience = 6;
        Returns:
        The baselineAudience.

      • getBaselineAudienceOrBuilder

        InsightsAudienceOrBuilder getBaselineAudienceOrBuilder()
         The baseline audience to which the audience of interest is being
 compared.
        .google.ads.googleads.v14.services.InsightsAudience baseline_audience = 6;

      • getDataMonth

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

      • getDataMonthBytes

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

      • getDimensionsList

        java.util.List<AudienceInsightsDimensionEnum.AudienceInsightsDimension> getDimensionsList()
         Required. The audience dimensions for which composition insights should be
 returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the dimensions.

      • getDimensionsCount

        int getDimensionsCount()
         Required. The audience dimensions for which composition insights should be
 returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The count of dimensions.

      • getDimensions

        AudienceInsightsDimensionEnum.AudienceInsightsDimension getDimensions​(int index)
         Required. The audience dimensions for which composition insights should be
 returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index of the element to return.
        Returns:
        The dimensions at the given index.

      • getDimensionsValueList

        java.util.List<java.lang.Integer> getDimensionsValueList()
         Required. The audience dimensions for which composition insights should be
 returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the enum numeric values on the wire for dimensions.

      • getDimensionsValue

        int getDimensionsValue​(int index)
         Required. The audience dimensions for which composition insights should be
 returned.
        repeated .google.ads.googleads.v14.enums.AudienceInsightsDimensionEnum.AudienceInsightsDimension dimensions = 4 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of dimensions at the given index.

      • getCustomerInsightsGroup

        java.lang.String getCustomerInsightsGroup()
         The name of the customer being planned for.  This is a user-defined value.
        string customer_insights_group = 5;
        Returns:
        The customerInsightsGroup.

      • getCustomerInsightsGroupBytes

        com.google.protobuf.ByteString getCustomerInsightsGroupBytes()
         The name of the customer being planned for.  This is a user-defined value.
        string customer_insights_group = 5;
        Returns:
        The bytes for customerInsightsGroup.