Package com.google.ads.googleads.v18.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

    Modifier and Type
    Method
    Description
    String
    getCustomerId()
    Required.
    com.google.protobuf.ByteString
    getCustomerIdBytes()
    Required.
    int
    getPageSize()
    This field is deprecated and will be removed in a future version of the API.
    String
    getPageToken()
    Token of the page to retrieve.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Token of the page to retrieve.
    String
    getQuery()
    Required.
    com.google.protobuf.ByteString
    getQueryBytes()
    Required.
    SearchSettings
    getSearchSettings()
    Settings that allow users to specify request count, summary row, and results behavior.
    SearchSettingsOrBuilder
    getSearchSettingsOrBuilder()
    Settings that allow users to specify request count, summary row, and results behavior.
    boolean
    getValidateOnly()
    If true, the request is validated but not executed.
    boolean
    hasSearchSettings()
    Settings that allow users to specify request count, summary row, and results behavior.

    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 Details

    • getCustomerId

      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

      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

      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()
       This field is deprecated and will be removed in
 a future version of the API. As of v17, Google Ads API will return a
 `PAGE_SIZE_NOT_SUPPORTED` error if this field is set in the request body.
 See
 https://ads-developers.googleblog.com/2024/07/upcoming-changes-to-page-size-in-google.html
 to learn more details.
      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.

    • hasSearchSettings

      boolean hasSearchSettings()
       Settings that allow users to specify request count, summary row, and
 results behavior.
      .google.ads.googleads.v18.services.SearchSettings search_settings = 10;
      Returns:
      Whether the searchSettings field is set.

    • getSearchSettings

      SearchSettings getSearchSettings()
       Settings that allow users to specify request count, summary row, and
 results behavior.
      .google.ads.googleads.v18.services.SearchSettings search_settings = 10;
      Returns:
      The searchSettings.

    • getSearchSettingsOrBuilder

      SearchSettingsOrBuilder getSearchSettingsOrBuilder()
       Settings that allow users to specify request count, summary row, and
 results behavior.
      .google.ads.googleads.v18.services.SearchSettings search_settings = 10;