Class: Google::Apis::DigitalassetlinksV1::DigitalassetlinksService

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

Overview

Digital Asset Links API

Discovers relationships between online assets such as websites or mobile apps.

Examples:

require 'google/apis/digitalassetlinks_v1'

Digitalassetlinks = Google::Apis::DigitalassetlinksV1 # Alias the module
service = Digitalassetlinks::DigitalassetlinksService.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

#initializeDigitalassetlinksService


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

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

Instance Attribute Details

#keyString


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

def key
  @key
end

#quota_userString


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

def quota_user
  @quota_user
end

Instance Method Details

Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with http:// instead of https://), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the Digital Asset Links technical design specification.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'generated/google/apis/digitalassetlinks_v1/service.rb', line 195

def check_assetlink(relation: nil, source_android_app_certificate_sha256_fingerprint: nil, source_android_app_package_name: nil, source_web_site: nil, target_android_app_certificate_sha256_fingerprint: nil, target_android_app_package_name: nil, target_web_site: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/assetlinks:check', options)
  command.response_representation = Google::Apis::DigitalassetlinksV1::CheckResponse::Representation
  command.response_class = Google::Apis::DigitalassetlinksV1::CheckResponse
  command.query['relation'] = relation unless relation.nil?
  command.query['source.androidApp.certificate.sha256Fingerprint'] = source_android_app_certificate_sha256_fingerprint unless source_android_app_certificate_sha256_fingerprint.nil?
  command.query['source.androidApp.packageName'] = source_android_app_package_name unless source_android_app_package_name.nil?
  command.query['source.web.site'] = source_web_site unless source_web_site.nil?
  command.query['target.androidApp.certificate.sha256Fingerprint'] = target_android_app_certificate_sha256_fingerprint unless target_android_app_certificate_sha256_fingerprint.nil?
  command.query['target.androidApp.packageName'] = target_android_app_package_name unless target_android_app_package_name.nil?
  command.query['target.web.site'] = target_web_site unless target_web_site.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_statements(relation: nil, source_android_app_certificate_sha256_fingerprint: nil, source_android_app_package_name: nil, source_web_site: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DigitalassetlinksV1::ListResponse

Retrieves a list of all statements from a given source that match the specified target and statement string. The API guarantees that all statements with secure source assets, such as HTTPS websites or Android apps, have been made in a secure way by the owner of those assets, as described in the Digital Asset Links technical design specification. Specifically, you should consider that for insecure websites (that is, where the URL starts with http:// instead of https://), this guarantee cannot be made. The List command is most useful in cases where the API client wants to know all the ways in which two assets are related, or enumerate all the relationships from a particular source asset. Example: a feature that helps users navigate to related items. When a mobile app is running on a device, the feature would make it easy to navigate to the corresponding web site or Google+ profile.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


302
303
304
305
306
307
308
309
310
311
312
313
# File 'generated/google/apis/digitalassetlinks_v1/service.rb', line 302

def list_statements(relation: nil, source_android_app_certificate_sha256_fingerprint: nil, source_android_app_package_name: nil, source_web_site: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/statements:list', options)
  command.response_representation = Google::Apis::DigitalassetlinksV1::ListResponse::Representation
  command.response_class = Google::Apis::DigitalassetlinksV1::ListResponse
  command.query['relation'] = relation unless relation.nil?
  command.query['source.androidApp.certificate.sha256Fingerprint'] = source_android_app_certificate_sha256_fingerprint unless source_android_app_certificate_sha256_fingerprint.nil?
  command.query['source.androidApp.packageName'] = source_android_app_package_name unless source_android_app_package_name.nil?
  command.query['source.web.site'] = source_web_site unless source_web_site.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end