EmbedsDeepLinkData

GoogleApi.ContentWarehouse.V1.Model.EmbedsDeepLinkData


Table of Contents ▼

Jump to a specific part of the page:

Description

Deep-linking data is used to construct a deep-link URI for an activity or frame's embed, such that on click, the user is taken to the right place in a mobile app. If the app is not installed, the user is taken to the app store. If not on mobile, an analogous web uri is used.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. appId (type: String.t, default: nil)
    - Application ID (or project ID) from Google API Console.
  2. client (type: list(GoogleApi.ContentWarehouse.V1.Model.EmbedsPackagingServiceClient), default: nil)
    - The data for a Google API Console client is entered by a developer during client registration and is stored in PackagingService.
  3. deepLinkId (type: String.t, default: nil)
    - The ID for non-URL content. Embeds may either have no analogous web presence or prefer a native mobile experience if supported. In the case of no web presence, instead of setting the "url" field of an embed, such developers will set this field and other content fields, e.g. thumbnail, title, description. If set, this field is used to construct the deep-link URI. Note that the native experience is preferred over the web link and the web link is used as a fallback.
  4. url (type: String.t, default: nil)
    - Analogous web presence. Used as desktop fallback or when no native link data is present.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.EmbedsDeepLinkData{
appId: String.t() | nil,
client: [GoogleApi.ContentWarehouse.V1.Model.EmbedsPackagingServiceClient.t()] | nil,
deepLinkId: String.t() | nil,
url: String.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.EmbedsDeepLinkData