Class: Google::Apis::WebfontsV1::WebfontsService

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

Overview

Web Fonts Developer API

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

Examples:

require 'google/apis/webfonts_v1'

Webfonts = Google::Apis::WebfontsV1 # Alias the module
service = Webfonts::WebfontsService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://webfonts.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebfontsService

Returns a new instance of WebfontsService.



48
49
50
51
52
53
 
# File 'lib/google/apis/webfonts_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-webfonts_v1',
        client_version: Google::Apis::WebfontsV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



41
42
43
 
# File 'lib/google/apis/webfonts_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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.



46
47
48
 
# File 'lib/google/apis/webfonts_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#list_webfonts(capability: nil, family: nil, sort: nil, subset: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebfontsV1::WebfontList

Retrieves the list of fonts currently served by the Google Fonts Developer API.

Parameters:

  • capability (Array<String>, String) (defaults to: nil) —

    Controls the font urls in Webfont.files, by default, static ttf fonts are sent.

  • family (Array<String>, String) (defaults to: nil) —

    Filters by Webfont.family, using literal match. If not set, returns all families

  • sort (String) (defaults to: nil) —

    Enables sorting of the list.

  • subset (String) (defaults to: nil) —

    Filters by Webfont.subset, if subset is found in Webfont.subsets. If not set, returns all families.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/google/apis/webfonts_v1/service.rb', line 84

def list_webfonts(capability: nil, family: nil, sort: nil, subset: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/webfonts', options)
  command.response_representation = Google::Apis::WebfontsV1::WebfontList::Representation
  command.response_class = Google::Apis::WebfontsV1::WebfontList
  command.query['capability'] = capability unless capability.nil?
  command.query['family'] = family unless family.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['subset'] = subset unless subset.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end