Class: Google::Apis::FactchecktoolsV1alpha1::FactCheckToolsService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/factchecktools_v1alpha1/service.rb

Overview

Fact Check Tools API

Examples:

require 'google/apis/factchecktools_v1alpha1'

Factchecktools = Google::Apis::FactchecktoolsV1alpha1 # Alias the module
service = Factchecktools::FactCheckToolsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeFactCheckToolsService

Returns a new instance of FactCheckToolsService.


45
46
47
48
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 45

def initialize
  super('https://factchecktools.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


43
44
45
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#create_page(google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage

Create ClaimReview markup on a page.

Parameters:

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


127
128
129
130
131
132
133
134
135
136
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 127

def create_page(google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/pages', options)
  command.request_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage::Representation
  command.request_object = google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object
  command.response_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage::Representation
  command.response_class = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_page(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FactchecktoolsV1alpha1::GoogleProtobufEmpty

Delete all ClaimReview markup on a page.

Parameters:

  • name (String)

    The name of the resource to delete, in the form of pages/page_id``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


158
159
160
161
162
163
164
165
166
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 158

def delete_page(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::FactchecktoolsV1alpha1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_page(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage

Get all ClaimReview markup on a page.

Parameters:

  • name (String)

    The name of the resource to get, in the form of pages/page_id``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


188
189
190
191
192
193
194
195
196
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 188

def get_page(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage::Representation
  command.response_class = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_pages(offset: nil, organization: nil, page_size: nil, page_token: nil, url: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ListClaimReviewMarkupPagesResponse

List the ClaimReview markup pages for a specific URL or for an organization.

Parameters:

  • offset (Fixnum) (defaults to: nil)

    An integer that specifies the current offset (that is, starting result location) in search results. This field is only considered if page_token is unset, and if the request is not for a specific URL. For example, 0 means to return results starting from the first matching result, and 10 means to return from the 11th result.

  • organization (String) (defaults to: nil)

    The organization for which we want to fetch markups for. For instance, "site.com". Cannot be specified along with an URL.

  • page_size (Fixnum) (defaults to: nil)

    The pagination size. We will return up to that many results. Defaults to 10 if not set. Has no effect if a URL is requested.

  • page_token (String) (defaults to: nil)

    The pagination token. You may provide the next_page_token returned from a previous List request, if any, in order to get the next page. All other fields must have the same values as in the previous request.

  • url (String) (defaults to: nil)

    The URL from which to get ClaimReview markup. There will be at most one result. If markup is associated with a more canonical version of the URL provided, we will return that URL instead. Cannot be specified along with an organization.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 238

def list_pages(offset: nil, organization: nil, page_size: nil, page_token: nil, url: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/pages', options)
  command.response_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ListClaimReviewMarkupPagesResponse::Representation
  command.response_class = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ListClaimReviewMarkupPagesResponse
  command.query['offset'] = offset unless offset.nil?
  command.query['organization'] = organization unless organization.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['url'] = url unless url.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_claims(language_code: nil, max_age_days: nil, offset: nil, page_size: nil, page_token: nil, query: nil, review_publisher_site_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimSearchResponse

Search through fact-checked claims.

Parameters:

  • language_code (String) (defaults to: nil)

    The BCP-47 language code, such as "en-US" or "sr-Latn". Can be used to restrict results by language, though we do not currently consider the region.

  • max_age_days (Fixnum) (defaults to: nil)

    The maximum age of the returned search results, in days. Age is determined by either claim date or review date, whichever is newer.

  • offset (Fixnum) (defaults to: nil)

    An integer that specifies the current offset (that is, starting result location) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching result, and 10 means to return from the 11th result.

  • page_size (Fixnum) (defaults to: nil)

    The pagination size. We will return up to that many results. Defaults to 10 if not set.

  • page_token (String) (defaults to: nil)

    The pagination token. You may provide the next_page_token returned from a previous List request, if any, in order to get the next page. All other fields must have the same values as in the previous request.

  • query (String) (defaults to: nil)

    Textual query string. Required unless review_publisher_site_filter is specified.

  • review_publisher_site_filter (String) (defaults to: nil)

    The review publisher site to filter results by, e.g. nytimes.com.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 92

def search_claims(language_code: nil, max_age_days: nil, offset: nil, page_size: nil, page_token: nil, query: nil, review_publisher_site_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/claims:search', options)
  command.response_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimSearchResponse::Representation
  command.response_class = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1FactCheckedClaimSearchResponse
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['maxAgeDays'] = max_age_days unless max_age_days.nil?
  command.query['offset'] = offset unless offset.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['reviewPublisherSiteFilter'] = review_publisher_site_filter unless review_publisher_site_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_page(name, google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage

Update for all ClaimReview markup on a page Note that this is a full update. To retain the existing ClaimReview markup on a page, first perform a Get operation, then modify the returned markup, and finally call Update with the entire ClaimReview markup as the body.

Parameters:

  • name (String)

    The name of this ClaimReview markup page resource, in the form of pages/page_id``. Except for update requests, this field is output-only and should not be set by the user.

  • google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object (Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


279
280
281
282
283
284
285
286
287
288
289
# File 'generated/google/apis/factchecktools_v1alpha1/service.rb', line 279

def update_page(name, google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage::Representation
  command.request_object = google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object
  command.response_representation = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage::Representation
  command.response_class = Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end