Package firebasedynamiclinks

import "google.golang.org/api/firebasedynamiclinks/v1"
...
firebasedynamiclinksService, err := firebasedynamiclinks.New(oauthHttpClient)

Constants

OAuth2 scopes used by this API.

const (
    // View and administer all your Firebase data and settings
    FirebaseScope = "https://www.googleapis.com/auth/firebase"
)

type AnalyticsInfo ¶

AnalyticsInfo: Tracking parameters supported by Dynamic Link.

type AnalyticsInfo struct {
    // GooglePlayAnalytics: Google Play Campaign Measurements.
    GooglePlayAnalytics *GooglePlayAnalytics `json:"googlePlayAnalytics,omitempty"`

    // ItunesConnectAnalytics: iTunes Connect App Analytics.
    ItunesConnectAnalytics *ITunesConnectAnalytics `json:"itunesConnectAnalytics,omitempty"`

    // ForceSendFields is a list of field names (e.g. "GooglePlayAnalytics")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "GooglePlayAnalytics") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*AnalyticsInfo) MarshalJSON ¶

func (s *AnalyticsInfo) MarshalJSON() ([]byte, error)

type AndroidInfo ¶

AndroidInfo: Android related attributes to the Dynamic Link.

type AndroidInfo struct {
    // AndroidFallbackLink: Link to open on Android if the app is not
    // installed.
    AndroidFallbackLink string `json:"androidFallbackLink,omitempty"`

    // AndroidLink: If specified, this overrides the ‘link’ parameter on
    // Android.
    AndroidLink string `json:"androidLink,omitempty"`

    // AndroidMinPackageVersionCode: Minimum version code for the Android
    // app. If the installed app’s version
    // code is lower, then the user is taken to the Play Store.
    AndroidMinPackageVersionCode string `json:"androidMinPackageVersionCode,omitempty"`

    // AndroidPackageName: Android package name of the app.
    AndroidPackageName string `json:"androidPackageName,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AndroidFallbackLink")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AndroidFallbackLink") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*AndroidInfo) MarshalJSON ¶

func (s *AndroidInfo) MarshalJSON() ([]byte, error)

type CreateShortDynamicLinkRequest ¶

CreateShortDynamicLinkRequest: Request to create a short Dynamic Link.

type CreateShortDynamicLinkRequest struct {
    // DynamicLinkInfo: Information about the Dynamic Link to be
    // shortened.
    // [Learn
    // more](https://firebase.google.com/docs/dynamic-links/android#create-a-
    // dynamic-link-programmatically).
    DynamicLinkInfo *DynamicLinkInfo `json:"dynamicLinkInfo,omitempty"`

    // LongDynamicLink: Full long Dynamic Link URL with desired query
    // parameters specified.
    // For
    // example,
    // "https://sample.app.goo.gl/?link=http://www.google.com&apn=co
    // m.sample",
    // [Learn
    // more](https://firebase.google.com/docs/dynamic-links/android#create-a-
    // dynamic-link-programmatically).
    LongDynamicLink string `json:"longDynamicLink,omitempty"`

    // Suffix: Short Dynamic Link suffix. Optional.
    Suffix *Suffix `json:"suffix,omitempty"`

    // ForceSendFields is a list of field names (e.g. "DynamicLinkInfo") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DynamicLinkInfo") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*CreateShortDynamicLinkRequest) MarshalJSON ¶

func (s *CreateShortDynamicLinkRequest) MarshalJSON() ([]byte, error)

type CreateShortDynamicLinkResponse ¶

CreateShortDynamicLinkResponse: Response to create a short Dynamic Link.

type CreateShortDynamicLinkResponse struct {
    // PreviewLink: Preivew link to show the link flow chart.
    PreviewLink string `json:"previewLink,omitempty"`

    // ShortLink: Short Dynamic Link value. e.g.
    // https://abcd.app.goo.gl/wxyz
    ShortLink string `json:"shortLink,omitempty"`

    // Warning: Information about potential warnings on link creation.
    Warning []*DynamicLinkWarning `json:"warning,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "PreviewLink") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "PreviewLink") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*CreateShortDynamicLinkResponse) MarshalJSON ¶

func (s *CreateShortDynamicLinkResponse) MarshalJSON() ([]byte, error)

type DynamicLinkEventStat ¶

DynamicLinkEventStat: Dynamic Link event stat.

type DynamicLinkEventStat struct {
    // Count: The number of times this event occurred.
    Count int64 `json:"count,omitempty,string"`

    // Event: Link event.
    //
    // Possible values:
    //   "DYNAMIC_LINK_EVENT_UNSPECIFIED" - Unspecified type.
    //   "CLICK" - Indicates that an FDL is clicked by users.
    //   "REDIRECT" - Indicates that an FDL redirects users to fallback
    // link.
    //   "APP_INSTALL" - Indicates that an FDL triggers an app install from
    // Play store, currently
    // it's impossible to get stats from App store.
    //   "APP_FIRST_OPEN" - Indicates that the app is opened for the first
    // time after an install
    // triggered by FDLs
    //   "APP_RE_OPEN" - Indicates that the app is opened via an FDL for
    // non-first time.
    Event string `json:"event,omitempty"`

    // Platform: Requested platform.
    //
    // Possible values:
    //   "DYNAMIC_LINK_PLATFORM_UNSPECIFIED" - Unspecified platform.
    //   "ANDROID" - Represents Android platform.
    // All apps and browsers on Android are classfied in this category.
    //   "IOS" - Represents iOS platform.
    // All apps and browsers on iOS are classfied in this category.
    //   "DESKTOP" - Represents desktop.
    // Note: other platforms like Windows, Blackberry, Amazon fall into
    // this
    // category.
    Platform string `json:"platform,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Count") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Count") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*DynamicLinkEventStat) MarshalJSON ¶

func (s *DynamicLinkEventStat) MarshalJSON() ([]byte, error)

type DynamicLinkInfo ¶

DynamicLinkInfo: Information about a Dynamic Link.

type DynamicLinkInfo struct {
    // AnalyticsInfo: Parameters used for tracking. See all tracking
    // parameters in
    // the
    // [documentation](https://firebase.google.com/docs/dynamic-links/cre
    // ate-manually).
    AnalyticsInfo *AnalyticsInfo `json:"analyticsInfo,omitempty"`

    // AndroidInfo: Android related information. See Android related
    // parameters in
    // the
    // [documentation](https://firebase.google.com/docs/dynamic-links/cre
    // ate-manually).
    AndroidInfo *AndroidInfo `json:"androidInfo,omitempty"`

    // DynamicLinkDomain: Dynamic Links domain that the project owns, e.g.
    // abcd.app.goo.gl
    // [Learn
    // more](https://firebase.google.com/docs/dynamic-links/android/receive)
    //
    // on how to set up Dynamic Link domain associated with your Firebase
    // project.
    //
    // Required.
    DynamicLinkDomain string `json:"dynamicLinkDomain,omitempty"`

    // IosInfo: iOS related information. See iOS related parameters in
    // the
    // [documentation](https://firebase.google.com/docs/dynamic-links/cre
    // ate-manually).
    IosInfo *IosInfo `json:"iosInfo,omitempty"`

    // Link: The link your app will open, You can specify any URL your app
    // can handle.
    // This link must be a well-formatted URL, be properly URL-encoded, and
    // use
    // the HTTP or HTTPS scheme. See 'link' parameters in
    // the
    // [documentation](https://firebase.google.com/docs/dynamic-links/cre
    // ate-manually).
    //
    // Required.
    Link string `json:"link,omitempty"`

    // NavigationInfo: Information of navigation behavior of a Firebase
    // Dynamic Links.
    NavigationInfo *NavigationInfo `json:"navigationInfo,omitempty"`

    // SocialMetaTagInfo: Parameters for social meta tag params.
    // Used to set meta tag data for link previews on social sites.
    SocialMetaTagInfo *SocialMetaTagInfo `json:"socialMetaTagInfo,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AnalyticsInfo") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AnalyticsInfo") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*DynamicLinkInfo) MarshalJSON ¶

func (s *DynamicLinkInfo) MarshalJSON() ([]byte, error)

type DynamicLinkStats ¶

DynamicLinkStats: Analytics stats of a Dynamic Link for a given timeframe.

type DynamicLinkStats struct {
    // LinkEventStats: Dynamic Link event stats.
    LinkEventStats []*DynamicLinkEventStat `json:"linkEventStats,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "LinkEventStats") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "LinkEventStats") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*DynamicLinkStats) MarshalJSON ¶

func (s *DynamicLinkStats) MarshalJSON() ([]byte, error)

type DynamicLinkWarning ¶

DynamicLinkWarning: Dynamic Links warning messages.

type DynamicLinkWarning struct {
    // WarningCode: The warning code.
    //
    // Possible values:
    //   "CODE_UNSPECIFIED" - Unknown code.
    //   "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME" - The Android package does
    // not match any in developer's DevConsole project.
    //   "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION" - The Android minimum
    // version code has to be a valid integer.
    //   "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION" - Android package min
    // version param is not needed, e.g. when
    // 'apn' is missing.
    //   "NOT_URI_ANDROID_LINK" - Android link is not a valid URI.
    //   "UNNECESSARY_ANDROID_LINK" - Android link param is not needed, e.g.
    // when param 'al' and 'link' have
    // the same value..
    //   "NOT_URI_ANDROID_FALLBACK_LINK" - Android fallback link is not a
    // valid URI.
    //   "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK" - Android fallback link has
    // an invalid (non http/https) URI scheme.
    //   "NOT_IN_PROJECT_IOS_BUNDLE_ID" - The iOS bundle ID does not match
    // any in developer's DevConsole project.
    //   "NOT_IN_PROJECT_IPAD_BUNDLE_ID" - The iPad bundle ID does not match
    // any in developer's DevConsole project.
    //   "UNNECESSARY_IOS_URL_SCHEME" - iOS URL scheme is not needed, e.g.
    // when 'ibi' are 'ipbi' are all missing.
    //   "NOT_NUMERIC_IOS_APP_STORE_ID" - iOS app store ID format is
    // incorrect, e.g. not numeric.
    //   "UNNECESSARY_IOS_APP_STORE_ID" - iOS app store ID is not needed.
    //   "NOT_URI_IOS_FALLBACK_LINK" - iOS fallback link is not a valid URI.
    //   "BAD_URI_SCHEME_IOS_FALLBACK_LINK" - iOS fallback link has an
    // invalid (non http/https) URI scheme.
    //   "NOT_URI_IPAD_FALLBACK_LINK" - iPad fallback link is not a valid
    // URI.
    //   "BAD_URI_SCHEME_IPAD_FALLBACK_LINK" - iPad fallback link has an
    // invalid (non http/https) URI scheme.
    //   "BAD_DEBUG_PARAM" - Debug param format is incorrect.
    //   "BAD_AD_PARAM" - isAd param format is incorrect.
    //   "DEPRECATED_PARAM" - Indicates a certain param is deprecated.
    //   "UNRECOGNIZED_PARAM" - Indicates certain paramater is not
    // recognized.
    //   "TOO_LONG_PARAM" - Indicates certain paramater is too long.
    //   "NOT_URI_SOCIAL_IMAGE_LINK" - Social meta tag image link is not a
    // valid URI.
    //   "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK" - Social meta tag image link has
    // an invalid (non http/https) URI scheme.
    //   "NOT_URI_SOCIAL_URL"
    //   "BAD_URI_SCHEME_SOCIAL_URL"
    //   "LINK_LENGTH_TOO_LONG" - Dynamic Link URL length is too long.
    //   "LINK_WITH_FRAGMENTS" - Dynamic Link URL contains fragments.
    //   "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID" - The iOS bundle ID does
    // not match with the given iOS store ID.
    WarningCode string `json:"warningCode,omitempty"`

    // WarningMessage: The warning message to help developers improve their
    // requests.
    WarningMessage string `json:"warningMessage,omitempty"`

    // ForceSendFields is a list of field names (e.g. "WarningCode") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "WarningCode") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*DynamicLinkWarning) MarshalJSON ¶

func (s *DynamicLinkWarning) MarshalJSON() ([]byte, error)

type GooglePlayAnalytics ¶

GooglePlayAnalytics: Parameters for Google Play Campaign Measurements. [Learn more](https://developers.google.com/analytics/devguides/collection/and roid/v4/campaigns#campaign-params)

type GooglePlayAnalytics struct {
    // Gclid: [AdWords autotagging
    // parameter](https://support.google.com/analytics/answer/1033981?hl=en);
    //
    // used to measure Google AdWords ads. This value is generated
    // dynamically
    // and should never be modified.
    Gclid string `json:"gclid,omitempty"`

    // UtmCampaign: Campaign name; used for keyword analysis to identify a
    // specific product
    // promotion or strategic campaign.
    UtmCampaign string `json:"utmCampaign,omitempty"`

    // UtmContent: Campaign content; used for A/B testing and
    // content-targeted ads to
    // differentiate ads or links that point to the same URL.
    UtmContent string `json:"utmContent,omitempty"`

    // UtmMedium: Campaign medium; used to identify a medium such as email
    // or cost-per-click.
    UtmMedium string `json:"utmMedium,omitempty"`

    // UtmSource: Campaign source; used to identify a search engine,
    // newsletter, or other
    // source.
    UtmSource string `json:"utmSource,omitempty"`

    // UtmTerm: Campaign term; used with paid search to supply the keywords
    // for ads.
    UtmTerm string `json:"utmTerm,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Gclid") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Gclid") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*GooglePlayAnalytics) MarshalJSON ¶

func (s *GooglePlayAnalytics) MarshalJSON() ([]byte, error)

type ITunesConnectAnalytics ¶

ITunesConnectAnalytics: Parameters for iTunes Connect App Analytics.

type ITunesConnectAnalytics struct {
    // At: Affiliate token used to create affiliate-coded links.
    At string `json:"at,omitempty"`

    // Ct: Campaign text that developers can optionally add to any link in
    // order to
    // track sales from a specific marketing campaign.
    Ct string `json:"ct,omitempty"`

    // Mt: iTune media types, including music, podcasts, audiobooks and so
    // on.
    Mt string `json:"mt,omitempty"`

    // Pt: Provider token that enables analytics for Dynamic Links from
    // within iTunes
    // Connect.
    Pt string `json:"pt,omitempty"`

    // ForceSendFields is a list of field names (e.g. "At") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "At") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*ITunesConnectAnalytics) MarshalJSON ¶

func (s *ITunesConnectAnalytics) MarshalJSON() ([]byte, error)

type IosInfo ¶

IosInfo: iOS related attributes to the Dynamic Link..

type IosInfo struct {
    // IosAppStoreId: iOS App Store ID.
    IosAppStoreId string `json:"iosAppStoreId,omitempty"`

    // IosBundleId: iOS bundle ID of the app.
    IosBundleId string `json:"iosBundleId,omitempty"`

    // IosCustomScheme: Custom (destination) scheme to use for iOS. By
    // default, we’ll use the
    // bundle ID as the custom scheme. Developer can override this behavior
    // using
    // this param.
    IosCustomScheme string `json:"iosCustomScheme,omitempty"`

    // IosFallbackLink: Link to open on iOS if the app is not installed.
    IosFallbackLink string `json:"iosFallbackLink,omitempty"`

    // IosIpadBundleId: iPad bundle ID of the app.
    IosIpadBundleId string `json:"iosIpadBundleId,omitempty"`

    // IosIpadFallbackLink: If specified, this overrides the
    // ios_fallback_link value on iPads.
    IosIpadFallbackLink string `json:"iosIpadFallbackLink,omitempty"`

    // ForceSendFields is a list of field names (e.g. "IosAppStoreId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "IosAppStoreId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*IosInfo) MarshalJSON ¶

func (s *IosInfo) MarshalJSON() ([]byte, error)

type NavigationInfo ¶

NavigationInfo: Information of navigation behavior.

type NavigationInfo struct {
    // EnableForcedRedirect: If this option is on, FDL click will be forced
    // to redirect rather than
    // show an interstitial page.
    EnableForcedRedirect bool `json:"enableForcedRedirect,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "EnableForcedRedirect") to unconditionally include in API requests.
    // By default, fields with empty values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "EnableForcedRedirect") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*NavigationInfo) MarshalJSON ¶

func (s *NavigationInfo) MarshalJSON() ([]byte, error)

type Service ¶

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    ShortLinks *ShortLinksService

    V1 *V1Service
    // contains filtered or unexported fields
}

func New ¶

func New(client *http.Client) (*Service, error)

type ShortLinksCreateCall ¶

type ShortLinksCreateCall struct {
    // contains filtered or unexported fields
}

func (*ShortLinksCreateCall) Context ¶

func (c *ShortLinksCreateCall) Context(ctx context.Context) *ShortLinksCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ShortLinksCreateCall) Do ¶

func (c *ShortLinksCreateCall) Do(opts ...googleapi.CallOption) (*CreateShortDynamicLinkResponse, error)

Do executes the "firebasedynamiclinks.shortLinks.create" call. Exactly one of *CreateShortDynamicLinkResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CreateShortDynamicLinkResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ShortLinksCreateCall) Fields ¶

func (c *ShortLinksCreateCall) Fields(s ...googleapi.Field) *ShortLinksCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ShortLinksCreateCall) Header ¶

func (c *ShortLinksCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ShortLinksService ¶

type ShortLinksService struct {
    // contains filtered or unexported fields
}

func NewShortLinksService ¶

func NewShortLinksService(s *Service) *ShortLinksService

func (*ShortLinksService) Create ¶

func (r *ShortLinksService) Create(createshortdynamiclinkrequest *CreateShortDynamicLinkRequest) *ShortLinksCreateCall

Create: Creates a short Dynamic Link given either a valid long Dynamic Link or details such as Dynamic Link domain, Android and iOS app information. The created short Dynamic Link will not expire.

Repeated calls with the same long Dynamic Link or Dynamic Link information will produce the same short Dynamic Link.

The Dynamic Link domain in the request must be owned by requester's Firebase project.

type SocialMetaTagInfo ¶

SocialMetaTagInfo: Parameters for social meta tag params. Used to set meta tag data for link previews on social sites.

type SocialMetaTagInfo struct {
    // SocialDescription: A short description of the link. Optional.
    SocialDescription string `json:"socialDescription,omitempty"`

    // SocialImageLink: An image url string. Optional.
    SocialImageLink string `json:"socialImageLink,omitempty"`

    // SocialTitle: Title to be displayed. Optional.
    SocialTitle string `json:"socialTitle,omitempty"`

    // ForceSendFields is a list of field names (e.g. "SocialDescription")
    // to unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "SocialDescription") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

func (*SocialMetaTagInfo) MarshalJSON ¶

func (s *SocialMetaTagInfo) MarshalJSON() ([]byte, error)

type Suffix ¶

Suffix: Short Dynamic Link suffix.

type Suffix struct {
    // Option: Suffix option.
    //
    // Possible values:
    //   "OPTION_UNSPECIFIED" - The suffix option is not specified, performs
    // as NOT_GUESSABLE .
    //   "UNGUESSABLE" - Short Dynamic Link suffix is a base62 [0-9A-Za-z]
    // encoded string of
    // a random generated 96 bit random number, which has a length of 17
    // chars.
    // For example, "nlAR8U4SlKRZw1cb2".
    // It prevents other people from guessing and crawling short Dynamic
    // Links
    // that contain personal identifiable information.
    //   "SHORT" - Short Dynamic Link suffix is a base62 [0-9A-Za-z] string
    // starting with a
    // length of 4 chars. the length will increase when all the space
    // is
    // occupied.
    Option string `json:"option,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Option") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Option") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

func (*Suffix) MarshalJSON ¶

func (s *Suffix) MarshalJSON() ([]byte, error)

type V1GetLinkStatsCall ¶

type V1GetLinkStatsCall struct {
    // contains filtered or unexported fields
}

func (*V1GetLinkStatsCall) Context ¶

func (c *V1GetLinkStatsCall) Context(ctx context.Context) *V1GetLinkStatsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1GetLinkStatsCall) Do ¶

func (c *V1GetLinkStatsCall) Do(opts ...googleapi.CallOption) (*DynamicLinkStats, error)

Do executes the "firebasedynamiclinks.getLinkStats" call. Exactly one of *DynamicLinkStats or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DynamicLinkStats.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1GetLinkStatsCall) DurationDays ¶

func (c *V1GetLinkStatsCall) DurationDays(durationDays int64) *V1GetLinkStatsCall

DurationDays sets the optional parameter "durationDays": The span of time requested in days.

func (*V1GetLinkStatsCall) Fields ¶

func (c *V1GetLinkStatsCall) Fields(s ...googleapi.Field) *V1GetLinkStatsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1GetLinkStatsCall) Header ¶

func (c *V1GetLinkStatsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*V1GetLinkStatsCall) IfNoneMatch ¶

func (c *V1GetLinkStatsCall) IfNoneMatch(entityTag string) *V1GetLinkStatsCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type V1Service ¶

type V1Service struct {
    // contains filtered or unexported fields
}

func NewV1Service ¶

func NewV1Service(s *Service) *V1Service

func (*V1Service) GetLinkStats ¶

func (r *V1Service) GetLinkStats(dynamicLink string) *V1GetLinkStatsCall

GetLinkStats: Fetches analytics stats of a short Dynamic Link for a given duration. Metrics include number of clicks, redirects, installs, app first opens, and app reopens.