Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ServicesSearchSearchAds360Response

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/searchads360_v0/classes.rb,
lib/google/apis/searchads360_v0/representations.rb,
lib/google/apis/searchads360_v0/representations.rb

Overview

Response message for SearchAds360Service.Search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ServicesSearchSearchAds360Response

Returns a new instance of GoogleAdsSearchads360V0ServicesSearchSearchAds360Response.



5938
5939
5940
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5938

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#custom_column_headers ⇒ Array<Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ServicesCustomColumnHeader>

The headers of the custom columns in the results. Corresponds to the JSON property customColumnHeaders

Returns:



5909
5910
5911
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5909

def custom_column_headers
  @custom_column_headers
end

#field_mask ⇒ String

FieldMask that represents what fields were requested by the user. Corresponds to the JSON property fieldMask

Returns:

  • (String) 


5914
5915
5916
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5914

def field_mask
  @field_mask
end

#next_page_token ⇒ String

Pagination token used to retrieve the next page of results. Pass the content of this string as the page_token attribute of the next request. next_page_token is not returned for the last page. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


5921
5922
5923
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5921

def next_page_token
  @next_page_token
end

#results ⇒ Array<Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ServicesSearchAds360Row>

The list of rows that matched the query. Corresponds to the JSON property results

Returns:



5926
5927
5928
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5926

def results
  @results
end

#summary_row ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ServicesSearchAds360Row

A returned row from the query. Corresponds to the JSON property summaryRow

Returns:



5931
5932
5933
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5931

def summary_row
  @summary_row
end

#total_results_count ⇒ Fixnum

Total number of results that match the query ignoring the LIMIT clause. Corresponds to the JSON property totalResultsCount

Returns:

  • (Fixnum) 


5936
5937
5938
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5936

def total_results_count
  @total_results_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5943
5944
5945
5946
5947
5948
5949
5950
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5943

def update!(**args)
  @custom_column_headers = args[:custom_column_headers] if args.key?(:custom_column_headers)
  @field_mask = args[:field_mask] if args.key?(:field_mask)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @results = args[:results] if args.key?(:results)
  @summary_row = args[:summary_row] if args.key?(:summary_row)
  @total_results_count = args[:total_results_count] if args.key?(:total_results_count)
end