com.google.ads.googleads.v17.services.SearchGoogleAdsRequestOrBuilder 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/google_ads_service.proto

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

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

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

  /**
   *    * Required. The query string.
   * 
   *
   * string query = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return The query.
   */
  java.lang.String getQuery();
  /**
   *    * Required. The query string.
   * 
   *
   * string query = 2 [(.google.api.field_behavior) = REQUIRED];
   * @return The bytes for query.
   */
  com.google.protobuf.ByteString
      getQueryBytes();

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

  /**
   *    * 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;
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *    * If true, the request is validated but not executed.
   * 
   *
   * bool validate_only = 5;
   * @return The validateOnly.
   */
  boolean getValidateOnly();

  /**
   *    * 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;
   * @return The returnTotalResultsCount.
   */
  boolean getReturnTotalResultsCount();

  /**
   *    * 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.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
   * @return The enum numeric value on the wire for summaryRowSetting.
   */
  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.v17.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 8;
   * @return The summaryRowSetting.
   */
  com.google.ads.googleads.v17.enums.SummaryRowSettingEnum.SummaryRowSetting getSummaryRowSetting();
}