Class: Google::Apis::SearchconsoleV1::IndexStatusInspectionResult

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

Overview

Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not. For more information, see the Index coverage report documentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ IndexStatusInspectionResult

Returns a new instance of IndexStatusInspectionResult.



366
367
368
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 366

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

Instance Attribute Details

#coverage_state ⇒ String

Could Google find and index the page. More details about page indexing appear in 'indexing_state'. Corresponds to the JSON property coverageState

Returns:

  • (String) 


304
305
306
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 304

def coverage_state
  @coverage_state
end

#crawled_as ⇒ String

Primary crawler that was used by Google to crawl your site. Corresponds to the JSON property crawledAs

Returns:

  • (String) 


309
310
311
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 309

def crawled_as
  @crawled_as
end

#google_canonical ⇒ String

The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent. Corresponds to the JSON property googleCanonical

Returns:

  • (String) 


315
316
317
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 315

def google_canonical
  @google_canonical
end

#indexing_state ⇒ String

Whether or not the page blocks indexing through a noindex rule. Corresponds to the JSON property indexingState

Returns:

  • (String) 


320
321
322
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 320

def indexing_state
  @indexing_state
end

#last_crawl_time ⇒ String

Last time this URL was crawled by Google using the primary crawler. Absent if the URL was never crawled successfully. Corresponds to the JSON property lastCrawlTime

Returns:

  • (String) 


327
328
329
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 327

def last_crawl_time
  @last_crawl_time
end

#page_fetch_state ⇒ String

Whether or not Google could retrieve the page from your server. Equivalent to "page fetch" in the URL inspection report. Corresponds to the JSON property pageFetchState

Returns:

  • (String) 


334
335
336
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 334

def page_fetch_state
  @page_fetch_state
end

#referring_urls ⇒ Array<String>

URLs that link to the inspected URL, directly and indirectly. Corresponds to the JSON property referringUrls

Returns:

  • (Array<String>) 


339
340
341
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 339

def referring_urls
  @referring_urls
end

#robots_txt_state ⇒ String

Whether or not the page is blocked to Google by a robots.txt rule. Corresponds to the JSON property robotsTxtState

Returns:

  • (String) 


344
345
346
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 344

def robots_txt_state
  @robots_txt_state
end

#sitemap ⇒ Array<String>

Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found. Corresponds to the JSON property sitemap

Returns:

  • (Array<String>) 


351
352
353
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 351

def sitemap
  @sitemap
end

#user_canonical ⇒ String

The URL that your page or site declares as canonical. If you did not declare a canonical URL, this field is absent. Corresponds to the JSON property userCanonical

Returns:

  • (String) 


358
359
360
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 358

def user_canonical
  @user_canonical
end

#verdict ⇒ String

High level verdict about whether the URL is indexed (indexed status), or * can be* indexed (live inspection). Corresponds to the JSON property verdict

Returns:

  • (String) 


364
365
366
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 364

def verdict
  @verdict
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 371

def update!(**args)
  @coverage_state = args[:coverage_state] if args.key?(:coverage_state)
  @crawled_as = args[:crawled_as] if args.key?(:crawled_as)
  @google_canonical = args[:google_canonical] if args.key?(:google_canonical)
  @indexing_state = args[:indexing_state] if args.key?(:indexing_state)
  @last_crawl_time = args[:last_crawl_time] if args.key?(:last_crawl_time)
  @page_fetch_state = args[:page_fetch_state] if args.key?(:page_fetch_state)
  @referring_urls = args[:referring_urls] if args.key?(:referring_urls)
  @robots_txt_state = args[:robots_txt_state] if args.key?(:robots_txt_state)
  @sitemap = args[:sitemap] if args.key?(:sitemap)
  @user_canonical = args[:user_canonical] if args.key?(:user_canonical)
  @verdict = args[:verdict] if args.key?(:verdict)
end