Show / Hide Table of Contents

Class StatementsResource.ListRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListResponse>
DigitalassetlinksBaseServiceRequest<ListResponse>
StatementsResource.ListRequest
Implements
IClientServiceRequest<ListResponse>
IClientServiceRequest
Inherited Members
DigitalassetlinksBaseServiceRequest<ListResponse>.Xgafv
DigitalassetlinksBaseServiceRequest<ListResponse>.AccessToken
DigitalassetlinksBaseServiceRequest<ListResponse>.Alt
DigitalassetlinksBaseServiceRequest<ListResponse>.Callback
DigitalassetlinksBaseServiceRequest<ListResponse>.Fields
DigitalassetlinksBaseServiceRequest<ListResponse>.Key
DigitalassetlinksBaseServiceRequest<ListResponse>.OauthToken
DigitalassetlinksBaseServiceRequest<ListResponse>.PrettyPrint
DigitalassetlinksBaseServiceRequest<ListResponse>.QuotaUser
DigitalassetlinksBaseServiceRequest<ListResponse>.UploadType
DigitalassetlinksBaseServiceRequest<ListResponse>.UploadProtocol
ClientServiceRequest<ListResponse>.Execute()
ClientServiceRequest<ListResponse>.ExecuteAsStream()
ClientServiceRequest<ListResponse>.ExecuteAsync()
ClientServiceRequest<ListResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListResponse>.CreateRequest(bool?)
ClientServiceRequest<ListResponse>.GenerateRequestUri()
ClientServiceRequest<ListResponse>.GetBody()
ClientServiceRequest<ListResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListResponse>.ETagAction
ClientServiceRequest<ListResponse>.ModifyRequest
ClientServiceRequest<ListResponse>.ValidateParameters
ClientServiceRequest<ListResponse>.ApiVersion
ClientServiceRequest<ListResponse>.RequestParameters
ClientServiceRequest<ListResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Digitalassetlinks.v1
Assembly: Google.Apis.Digitalassetlinks.v1.dll
Syntax
public class StatementsResource.ListRequest : DigitalassetlinksBaseServiceRequest<ListResponse>, IClientServiceRequest<ListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListResponse>.MethodName

Relation

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 relation delegate_permission/common.handle_all_urls.

Declaration
[RequestParameter("relation", RequestParameterType.Query)]
public virtual string Relation { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListResponse>.RestPath

ReturnRelationExtensions

Whether to return any relation_extensions payloads specified in the source digital asset links statements. If this is set to false (default), relation_extensions specified will not be returned, even if they are specified in the DAL statement file. If set to true, the API will propagate relation_extensions associated with each statement's relation type, if specified in the DAL statement file.

Declaration
[RequestParameter("returnRelationExtensions", RequestParameterType.Query)]
public virtual bool? ReturnRelationExtensions { get; set; }
Property Value
Type Description
bool?

SourceAndroidAppCertificateSha256Fingerprint

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).

Declaration
[RequestParameter("source.androidApp.certificate.sha256Fingerprint", RequestParameterType.Query)]
public virtual string SourceAndroidAppCertificateSha256Fingerprint { get; set; }
Property Value
Type Description
string

SourceAndroidAppPackageName

Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name com.google.android.apps.maps. REQUIRED

Declaration
[RequestParameter("source.androidApp.packageName", RequestParameterType.Query)]
public virtual string SourceAndroidAppPackageName { get; set; }
Property Value
Type Description
string

SourceWebSite

Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://[:] 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

Declaration
[RequestParameter("source.web.site", RequestParameterType.Query)]
public virtual string SourceWebSite { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
DigitalassetlinksBaseServiceRequest<ListResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX