Package com.google.ads.googleads.v10.services

Interface SearchGoogleAdsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchGoogleAdsRequest, SearchGoogleAdsRequest.Builder
    public interface SearchGoogleAdsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCustomerId()
      Required.
      com.google.protobuf.ByteString getCustomerIdBytes()
      Required.
      int getPageSize()
      Number of elements to retrieve in a single page.
      java.lang.String getPageToken()
      Token of the page to retrieve.
      com.google.protobuf.ByteString getPageTokenBytes()
      Token of the page to retrieve.
      java.lang.String getQuery()
      Required.
      com.google.protobuf.ByteString getQueryBytes()
      Required.
      boolean getReturnTotalResultsCount()
      If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response.
      SummaryRowSettingEnum.SummaryRowSetting getSummaryRowSetting()
      Determines whether a summary row will be returned.
      int getSummaryRowSettingValue()
      Determines whether a summary row will be returned.
      boolean getValidateOnly()
      If true, the request is validated but not executed.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getCustomerId

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

      • getCustomerIdBytes

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

      • getQuery

        java.lang.String getQuery()
         Required. The query string.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The query.

      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         Required. The query string.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for query.

      • getPageToken

        java.lang.String getPageToken()
         Token of the page to retrieve. If not specified, the first
 page of results will be returned. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
        string page_token = 3;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Token of the page to retrieve. If not specified, the first
 page of results will be returned. Use the value obtained from
 `next_page_token` in the previous response in order to request
 the next page of results.
        string page_token = 3;
        Returns:
        The bytes for pageToken.

      • getPageSize

        int getPageSize()
         Number of elements to retrieve in a single page.
 When too large a page is requested, the server may decide to
 further limit the number of returned resources.
        int32 page_size = 4;
        Returns:
        The pageSize.

      • getValidateOnly

        boolean getValidateOnly()
         If true, the request is validated but not executed.
        bool validate_only = 5;
        Returns:
        The validateOnly.

      • getReturnTotalResultsCount

        boolean getReturnTotalResultsCount()
         If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
        bool return_total_results_count = 7;
        Returns:
        The returnTotalResultsCount.

      • getSummaryRowSettingValue

        int getSummaryRowSettingValue()
         Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
        Returns:
        The enum numeric value on the wire for summaryRowSetting.

      • getSummaryRowSetting

        SummaryRowSettingEnum.SummaryRowSetting getSummaryRowSetting()
         Determines whether a summary row will be returned. By default, summary row
 is not returned. If requested, the summary row will be sent in a response
 by itself after all other query results are returned.
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
        Returns:
        The summaryRowSetting.