google_api_digital_asset_links v0.8.0 GoogleApi.DigitalAssetLinks.V1.Api.Statements View Source
API calls for all endpoints tagged Statements
.
Link to this section Summary
Functions
Retrieves a list of all statements from a given source that match the specified target and statement string.
Link to this section Functions
digitalassetlinks_statements_list(connection, optional_params \\ [], opts \\ [])
View Sourcedigitalassetlinks_statements_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.DigitalAssetLinks.V1.Model.ListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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.
Parameters
connection
(type:GoogleApi.DigitalAssetLinks.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:relation
(type:String.t
) - Use only associations that match the specified relation.See the
Statement
message for a detailed definition of relation strings.For a query to match a statement, one of the following must be true:
- both the query's and the statement's relation strings match exactly, or
- the query's relation string is empty or missing.
Example: A query with relation
delegate_permission/common.handle_all_urls
matches an asset link with relationdelegate_permission/common.handle_all_urls
.:"source.androidApp.certificate.sha256Fingerprint"
(type:String.t
) - The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this:$ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5
or like this:
$ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5
In this example, the contents of this field would be
14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5
.If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons).
:"source.androidApp.packageName"
(type:String.t
) - Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package namecom.google.android.apps.maps
. REQUIRED:"source.web.site"
(type:String.t
) - Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format ishttp[s]://<hostname>[:<port>]
Hostnames must be fully qualified: they must end in a single period ("
.
").Only the schemes "http" and "https" are currently allowed.
Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https.
We call this limited URL the "site". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset.
Example: the asset with the site
https://www.google.com
contains all these URLs:https://www.google.com/
https://www.google.com:443/
https://www.google.com/foo
https://www.google.com/foo?bar
https://www.google.com/foo#bar
https://user@password:www.google.com/
But it does not contain these URLs:
http://www.google.com/
(wrong scheme)https://google.com/
(hostname does not match)https://www.google.com:444/
(port does not match) REQUIRED
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.DigitalAssetLinks.V1.Model.ListResponse{}}
on success{:error, info}
on failure