google-apis-rs/google_firebasedynamiclinks1_cli/search/search_index.json

{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"The firebasedynamiclinks1 command-line interface (CLI) allows to use most features of the Google Firebase Dynamic Links service from the comfort of your terminal. By default all output is printed to standard out, but flags can be set to direct it into a file independent of your shell's capabilities. Errors will be printed to standard error, and cause the program's exit code to be non-zero. If data-structures are requested, these will be returned as pretty-printed JSON, to be useful as input to other tools. Everything else about the Firebase Dynamic Links API can be found at the official documentation site . Installation and Source Code Install the command-line interface with cargo using: cargo install google-firebasedynamiclinks1-cli Find the source code on github . Usage This documentation was generated from the Firebase Dynamic Links API at revision 20240226 . The CLI is at version 5.0.4 . firebasedynamiclinks1 [options] managed-short-links create (-r <kv>)... [-p <v>]... [-o <out>] methods get-link-stats <dynamic-link> [-p <v>]... [-o <out>] install-attribution (-r <kv>)... [-p <v>]... [-o <out>] reopen-attribution (-r <kv>)... [-p <v>]... [-o <out>] short-links create (-r <kv>)... [-p <v>]... [-o <out>] firebasedynamiclinks1 --help Configuration: [--scope <url>]... Specify the authentication a method should be executed in. Each scope requires the user to grant this application permission to use it. If unset, it defaults to the shortest scope url for a particular method. --config-dir <folder> A directory into which we will store our persistent data. Defaults to a user-writable directory that we will create during the first invocation. [default: ~/.google-service-cli] Configuration The program will store all persistent data in the ~/.google-service-cli directory in JSON files prefixed with firebasedynamiclinks1- . You can change the directory used to store configuration with the --config-dir flag on a per-invocation basis. More information about the various kinds of persistent data are given in the following paragraphs. Authentication Most APIs require a user to authenticate any request. If this is the case, the scope determines the set of permissions granted. The granularity of these is usually no more than read-only or full-access . If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a method that is read-only, it will ask only for a read-only scope. You may use the --scope flag to specify a scope directly. All applicable scopes are documented in the respective method's CLI documentation. The first time a scope is used, the user is asked for permission. Follow the instructions given by the CLI to grant permissions, or to decline. If a scope was authenticated by the user, the respective information will be stored as JSON in the configuration directory, e.g. ~/.google-service-cli/firebasedynamiclinks1-token-<scope-hash>.json . No manual management of these tokens is necessary. To revoke granted authentication, please refer to the official documentation . Application Secrets In order to allow any application to use Google services, it will need to be registered using the Google Developer Console . APIs the application may use are then enabled for it one by one. Most APIs can be used for free and have a daily quota. To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI comes with a default application secret that is configured accordingly. This also means that heavy usage all around the world may deplete the daily quota. You can workaround this limitation by putting your own secrets file at this location: ~/.google-service-cli/firebasedynamiclinks1-secret.json , assuming that the required firebasedynamiclinks API was enabled for it. Such a secret file can be downloaded in the Google Developer Console at APIs & auth -> Credentials -> Download JSON and used as is. Learn more about how to setup Google projects and enable APIs using the official documentation . Debugging Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know what exactly led to a particular issue. This is done by allowing all client-server communication to be output to standard error as-is . The --debug flag will print errors using the Debug representation to standard error. You may consider redirecting standard error into a file for ease of use, e.g. firebasedynamiclinks1 --debug <resource> <method> [options] 2>debug.txt .","title":"Home"},{"location":"#installation-and-source-code","text":"Install the command-line interface with cargo using: cargo install google-firebasedynamiclinks1-cli Find the source code on github .","title":"Installation and Source Code"},{"location":"#usage","text":"This documentation was generated from the Firebase Dynamic Links API at revision 20240226 . The CLI is at version 5.0.4 . firebasedynamiclinks1 [options] managed-short-links create (-r <kv>)... [-p <v>]... [-o <out>] methods get-link-stats <dynamic-link> [-p <v>]... [-o <out>] install-attribution (-r <kv>)... [-p <v>]... [-o <out>] reopen-attribution (-r <kv>)... [-p <v>]... [-o <out>] short-links create (-r <kv>)... [-p <v>]... [-o <out>] firebasedynamiclinks1 --help Configuration: [--scope <url>]... Specify the authentication a method should be executed in. Each scope requires the user to grant this application permission to use it. If unset, it defaults to the shortest scope url for a particular method. --config-dir <folder> A directory into which we will store our persistent data. Defaults to a user-writable directory that we will create during the first invocation. [default: ~/.google-service-cli]","title":"Usage"},{"location":"#configuration","text":"The program will store all persistent data in the ~/.google-service-cli directory in JSON files prefixed with firebasedynamiclinks1- . You can change the directory used to store configuration with the --config-dir flag on a per-invocation basis. More information about the various kinds of persistent data are given in the following paragraphs.","title":"Configuration"},{"location":"#authentication","text":"Most APIs require a user to authenticate any request. If this is the case, the scope determines the set of permissions granted. The granularity of these is usually no more than read-only or full-access . If not set, the system will automatically select the smallest feasible scope, e.g. when invoking a method that is read-only, it will ask only for a read-only scope. You may use the --scope flag to specify a scope directly. All applicable scopes are documented in the respective method's CLI documentation. The first time a scope is used, the user is asked for permission. Follow the instructions given by the CLI to grant permissions, or to decline. If a scope was authenticated by the user, the respective information will be stored as JSON in the configuration directory, e.g. ~/.google-service-cli/firebasedynamiclinks1-token-<scope-hash>.json . No manual management of these tokens is necessary. To revoke granted authentication, please refer to the official documentation .","title":"Authentication"},{"location":"#application-secrets","text":"In order to allow any application to use Google services, it will need to be registered using the Google Developer Console . APIs the application may use are then enabled for it one by one. Most APIs can be used for free and have a daily quota. To allow more comfortable usage of the CLI without forcing anyone to register an own application, the CLI comes with a default application secret that is configured accordingly. This also means that heavy usage all around the world may deplete the daily quota. You can workaround this limitation by putting your own secrets file at this location: ~/.google-service-cli/firebasedynamiclinks1-secret.json , assuming that the required firebasedynamiclinks API was enabled for it. Such a secret file can be downloaded in the Google Developer Console at APIs & auth -> Credentials -> Download JSON and used as is. Learn more about how to setup Google projects and enable APIs using the official documentation .","title":"Application Secrets"},{"location":"#debugging","text":"Even though the CLI does its best to provide usable error messages, sometimes it might be desirable to know what exactly led to a particular issue. This is done by allowing all client-server communication to be output to standard error as-is . The --debug flag will print errors using the Debug representation to standard error. You may consider redirecting standard error into a file for ease of use, e.g. firebasedynamiclinks1 --debug <resource> <method> [options] 2>debug.txt .","title":"Debugging"},{"location":"managed-short-links_create/","text":"Creates a managed 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. This differs from CreateShortDynamicLink in the following ways: - The request will also contain a name for the link (non unique name for the front end). - The response must be authenticated with an auth token (generated with the admin service account). - The link will appear in the FDL list of links in the console front end. The Dynamic Link domain in the request must be owned by requester's Firebase project. Scopes You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> managed-short-links create ... Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateManagedShortLinkRequest: dynamic-link-info: analytics-info: google-play-analytics: gclid: string utm-campaign: string utm-content: string utm-medium: string utm-source: string utm-term: string itunes-connect-analytics: at: string ct: string mt: string pt: string android-info: android-fallback-link: string android-link: string android-min-package-version-code: string android-package-name: string desktop-info: desktop-fallback-link: string domain-uri-prefix: string dynamic-link-domain: string ios-info: ios-app-store-id: string ios-bundle-id: string ios-custom-scheme: string ios-fallback-link: string ios-ipad-bundle-id: string ios-ipad-fallback-link: string ios-minimum-version: string link: string navigation-info: enable-forced-redirect: boolean social-meta-tag-info: social-description: string social-image-link: string social-title: string long-dynamic-link: string name: string sdk-version: string suffix: custom-suffix: string option: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .dynamic-link-info.analytics-info.google-play-analytics gclid=et Deprecated; FDL SDK does not process nor log it. utm-campaign=magna Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign. utm-content=no Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL. utm-medium=ipsum Campaign medium; used to identify a medium such as email or cost-per-click. utm-source=voluptua. Campaign source; used to identify a search engine, newsletter, or other source. utm-term=at Campaign term; used with paid search to supply the keywords for ads. ..itunes-connect-analytics at=sanctus Affiliate token used to create affiliate-coded links. ct=sed Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign. mt=amet. iTune media types, including music, podcasts, audiobooks and so on. pt=takimata Provider token that enables analytics for Dynamic Links from within iTunes Connect. ...android-info android-fallback-link=amet. Link to open on Android if the app is not installed. android-link=duo If specified, this overrides the \u2018link\u2019 parameter on Android. android-min-package-version-code=ipsum Minimum version code for the Android app. If the installed app\u2019s version code is lower, then the user is taken to the Play Store. android-package-name=gubergren Android package name of the app. ..desktop-info desktop-fallback-link=lorem Link to open on desktop. .. domain-uri-prefix=gubergren E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing dynamic-link-domain=eos Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix. ios-info ios-app-store-id=dolor iOS App Store ID. ios-bundle-id=ea iOS bundle ID of the app. ios-custom-scheme=ipsum Custom (destination) scheme to use for iOS. By default, we\u2019ll use the bundle ID as the custom scheme. Developer can override this behavior using this param. ios-fallback-link=invidunt Link to open on iOS if the app is not installed. ios-ipad-bundle-id=amet iPad bundle ID of the app. ios-ipad-fallback-link=duo If specified, this overrides the ios_fallback_link value on iPads. ios-minimum-version=ipsum iOS minimum version. .. link=sed 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 . Required. navigation-info enable-forced-redirect=true If this option is on, FDL click will be forced to redirect rather than show an interstitial page. ..social-meta-tag-info social-description=ipsum A short description of the link. Optional. social-image-link=ipsum An image url string. Optional. social-title=est Title to be displayed. Optional. ... long-dynamic-link=gubergren Full long Dynamic Link URL with desired query parameters specified. For example, \"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\", Learn more . name=ea Link name to associate with the link. It's used for marketer to identify manually-created links in the Firebase console (https://console.firebase.google.com/). Links must be named to be tracked. sdk-version=dolor Google SDK version. Version takes the form \"$major.$minor.$patch\" suffix custom-suffix=lorem Only applies to Option.CUSTOM. option=eos Suffix option. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Create"},{"location":"managed-short-links_create/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> managed-short-links create ...","title":"Scopes"},{"location":"managed-short-links_create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateManagedShortLinkRequest: dynamic-link-info: analytics-info: google-play-analytics: gclid: string utm-campaign: string utm-content: string utm-medium: string utm-source: string utm-term: string itunes-connect-analytics: at: string ct: string mt: string pt: string android-info: android-fallback-link: string android-link: string android-min-package-version-code: string android-package-name: string desktop-info: desktop-fallback-link: string domain-uri-prefix: string dynamic-link-domain: string ios-info: ios-app-store-id: string ios-bundle-id: string ios-custom-scheme: string ios-fallback-link: string ios-ipad-bundle-id: string ios-ipad-fallback-link: string ios-minimum-version: string link: string navigation-info: enable-forced-redirect: boolean social-meta-tag-info: social-description: string social-image-link: string social-title: string long-dynamic-link: string name: string sdk-version: string suffix: custom-suffix: string option: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .dynamic-link-info.analytics-info.google-play-analytics gclid=et Deprecated; FDL SDK does not process nor log it. utm-campaign=magna Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign. utm-content=no Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL. utm-medium=ipsum Campaign medium; used to identify a medium such as email or cost-per-click. utm-source=voluptua. Campaign source; used to identify a search engine, newsletter, or other source. utm-term=at Campaign term; used with paid search to supply the keywords for ads. ..itunes-connect-analytics at=sanctus Affiliate token used to create affiliate-coded links. ct=sed Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign. mt=amet. iTune media types, including music, podcasts, audiobooks and so on. pt=takimata Provider token that enables analytics for Dynamic Links from within iTunes Connect. ...android-info android-fallback-link=amet. Link to open on Android if the app is not installed. android-link=duo If specified, this overrides the \u2018link\u2019 parameter on Android. android-min-package-version-code=ipsum Minimum version code for the Android app. If the installed app\u2019s version code is lower, then the user is taken to the Play Store. android-package-name=gubergren Android package name of the app. ..desktop-info desktop-fallback-link=lorem Link to open on desktop. .. domain-uri-prefix=gubergren E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing dynamic-link-domain=eos Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix. ios-info ios-app-store-id=dolor iOS App Store ID. ios-bundle-id=ea iOS bundle ID of the app. ios-custom-scheme=ipsum Custom (destination) scheme to use for iOS. By default, we\u2019ll use the bundle ID as the custom scheme. Developer can override this behavior using this param. ios-fallback-link=invidunt Link to open on iOS if the app is not installed. ios-ipad-bundle-id=amet iPad bundle ID of the app. ios-ipad-fallback-link=duo If specified, this overrides the ios_fallback_link value on iPads. ios-minimum-version=ipsum iOS minimum version. .. link=sed 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 . Required. navigation-info enable-forced-redirect=true If this option is on, FDL click will be forced to redirect rather than show an interstitial page. ..social-meta-tag-info social-description=ipsum A short description of the link. Optional. social-image-link=ipsum An image url string. Optional. social-title=est Title to be displayed. Optional. ... long-dynamic-link=gubergren Full long Dynamic Link URL with desired query parameters specified. For example, \"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\", Learn more . name=ea Link name to associate with the link. It's used for marketer to identify manually-created links in the Firebase console (https://console.firebase.google.com/). Links must be named to be tracked. sdk-version=dolor Google SDK version. Version takes the form \"$major.$minor.$patch\" suffix custom-suffix=lorem Only applies to Option.CUSTOM. option=eos Suffix option.","title":"Required Request Value"},{"location":"managed-short-links_create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"managed-short-links_create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"managed-short-links_create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"methods_get-link-stats/","text":"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. Scopes You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> methods get-link-stats ... Required Scalar Argument <dynamic-link> (string) Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional Method Properties You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p duration-days=string The span of time requested in days. -p sdk-version=string Google SDK version. Version takes the form \"$major.$minor.$patch\" Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Get Link Stats"},{"location":"methods_get-link-stats/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> methods get-link-stats ...","title":"Scopes"},{"location":"methods_get-link-stats/#required-scalar-argument","text":"<dynamic-link> (string) Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz","title":"Required Scalar Argument"},{"location":"methods_get-link-stats/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"methods_get-link-stats/#optional-method-properties","text":"You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness. -p duration-days=string The span of time requested in days. -p sdk-version=string Google SDK version. Version takes the form \"$major.$minor.$patch\"","title":"Optional Method Properties"},{"location":"methods_get-link-stats/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"methods_install-attribution/","text":"Get iOS strong/weak-match info for post-install attribution. Scopes You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> methods install-attribution ... Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIosPostInstallAttributionRequest: app-installation-time: string bundle-id: string device: device-model-name: string language-code: string language-code-from-webview: string language-code-raw: string screen-resolution-height: string screen-resolution-width: string timezone: string ios-version: string retrieval-method: string sdk-version: string unique-match-link-to-check: string visual-style: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . app-installation-time=labore App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match. bundle-id=sed APP bundle ID. device device-model-name=duo Device model name. language-code=sed Device language code setting. language-code-from-webview=no Device language code setting obtained by executing JavaScript code in WebView. language-code-raw=stet Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS. screen-resolution-height=kasd Device display resolution height. screen-resolution-width=et Device display resolution width. timezone=sed Device timezone setting. .. ios-version=et iOS version, ie: 9.3.5. Consider adding \"build\". retrieval-method=et App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link. sdk-version=vero Google SDK version. Version takes the form \"$major.$minor.$patch\" unique-match-link-to-check=erat Possible unique matched link that server need to check before performing device heuristics match. If passed link is short server need to expand the link. If link is long server need to vslidate the link. visual-style=sed Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Install Attribution"},{"location":"methods_install-attribution/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> methods install-attribution ...","title":"Scopes"},{"location":"methods_install-attribution/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIosPostInstallAttributionRequest: app-installation-time: string bundle-id: string device: device-model-name: string language-code: string language-code-from-webview: string language-code-raw: string screen-resolution-height: string screen-resolution-width: string timezone: string ios-version: string retrieval-method: string sdk-version: string unique-match-link-to-check: string visual-style: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . app-installation-time=labore App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is a client signal for a more accurate weak match. bundle-id=sed APP bundle ID. device device-model-name=duo Device model name. language-code=sed Device language code setting. language-code-from-webview=no Device language code setting obtained by executing JavaScript code in WebView. language-code-raw=stet Device language code raw setting. iOS does returns language code in different format than iOS WebView. For example WebView returns en_US, but iOS returns en-US. Field below will return raw value returned by iOS. screen-resolution-height=kasd Device display resolution height. screen-resolution-width=et Device display resolution width. timezone=sed Device timezone setting. .. ios-version=et iOS version, ie: 9.3.5. Consider adding \"build\". retrieval-method=et App post install attribution retrieval information. Disambiguates mechanism (iSDK or developer invoked) to retrieve payload from clicked link. sdk-version=vero Google SDK version. Version takes the form \"$major.$minor.$patch\" unique-match-link-to-check=erat Possible unique matched link that server need to check before performing device heuristics match. If passed link is short server need to expand the link. If link is long server need to vslidate the link. visual-style=sed Strong match page information. Disambiguates between default UI and custom page to present when strong match succeeds/fails to find cookie.","title":"Required Request Value"},{"location":"methods_install-attribution/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"methods_install-attribution/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"methods_install-attribution/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"methods_reopen-attribution/","text":"Get iOS reopen attribution for app universal link open deeplinking. Scopes You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> methods reopen-attribution ... Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIosReopenAttributionRequest: bundle-id: string requested-link: string sdk-version: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . bundle-id=duo APP bundle ID. requested-link=dolore FDL link to be verified from an app universal link open. The FDL link can be one of: 1) short FDL. e.g. .page.link/, or 2) long FDL. e.g. .page.link/?{query params}, or 3) Invite FDL. e.g. .page.link/i/ sdk-version=et Google SDK version. Version takes the form \"$major.$minor.$patch\" About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Reopen Attribution"},{"location":"methods_reopen-attribution/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> methods reopen-attribution ...","title":"Scopes"},{"location":"methods_reopen-attribution/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: GetIosReopenAttributionRequest: bundle-id: string requested-link: string sdk-version: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r . bundle-id=duo APP bundle ID. requested-link=dolore FDL link to be verified from an app universal link open. The FDL link can be one of: 1) short FDL. e.g. .page.link/, or 2) long FDL. e.g. .page.link/?{query params}, or 3) Invite FDL. e.g. .page.link/i/ sdk-version=et Google SDK version. Version takes the form \"$major.$minor.$patch\"","title":"Required Request Value"},{"location":"methods_reopen-attribution/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"methods_reopen-attribution/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"methods_reopen-attribution/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"},{"location":"short-links_create/","text":"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. Scopes You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> short-links create ... Required Request Value The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateShortDynamicLinkRequest: dynamic-link-info: analytics-info: google-play-analytics: gclid: string utm-campaign: string utm-content: string utm-medium: string utm-source: string utm-term: string itunes-connect-analytics: at: string ct: string mt: string pt: string android-info: android-fallback-link: string android-link: string android-min-package-version-code: string android-package-name: string desktop-info: desktop-fallback-link: string domain-uri-prefix: string dynamic-link-domain: string ios-info: ios-app-store-id: string ios-bundle-id: string ios-custom-scheme: string ios-fallback-link: string ios-ipad-bundle-id: string ios-ipad-fallback-link: string ios-minimum-version: string link: string navigation-info: enable-forced-redirect: boolean social-meta-tag-info: social-description: string social-image-link: string social-title: string long-dynamic-link: string sdk-version: string suffix: custom-suffix: string option: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .dynamic-link-info.analytics-info.google-play-analytics gclid=voluptua. Deprecated; FDL SDK does not process nor log it. utm-campaign=amet. Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign. utm-content=consetetur Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL. utm-medium=diam Campaign medium; used to identify a medium such as email or cost-per-click. utm-source=dolor Campaign source; used to identify a search engine, newsletter, or other source. utm-term=et Campaign term; used with paid search to supply the keywords for ads. ..itunes-connect-analytics at=et Affiliate token used to create affiliate-coded links. ct=sadipscing Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign. mt=stet iTune media types, including music, podcasts, audiobooks and so on. pt=dolor Provider token that enables analytics for Dynamic Links from within iTunes Connect. ...android-info android-fallback-link=duo Link to open on Android if the app is not installed. android-link=vero If specified, this overrides the \u2018link\u2019 parameter on Android. android-min-package-version-code=vero Minimum version code for the Android app. If the installed app\u2019s version code is lower, then the user is taken to the Play Store. android-package-name=invidunt Android package name of the app. ..desktop-info desktop-fallback-link=stet Link to open on desktop. .. domain-uri-prefix=vero E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing dynamic-link-domain=elitr Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix. ios-info ios-app-store-id=lorem iOS App Store ID. ios-bundle-id=diam iOS bundle ID of the app. ios-custom-scheme=no Custom (destination) scheme to use for iOS. By default, we\u2019ll use the bundle ID as the custom scheme. Developer can override this behavior using this param. ios-fallback-link=ipsum Link to open on iOS if the app is not installed. ios-ipad-bundle-id=accusam iPad bundle ID of the app. ios-ipad-fallback-link=takimata If specified, this overrides the ios_fallback_link value on iPads. ios-minimum-version=consetetur iOS minimum version. .. link=voluptua. 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 . Required. navigation-info enable-forced-redirect=false If this option is on, FDL click will be forced to redirect rather than show an interstitial page. ..social-meta-tag-info social-description=erat A short description of the link. Optional. social-image-link=consetetur An image url string. Optional. social-title=amet. Title to be displayed. Optional. ... long-dynamic-link=sed Full long Dynamic Link URL with desired query parameters specified. For example, \"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\", Learn more . sdk-version=takimata Google SDK version. Version takes the form \"$major.$minor.$patch\" suffix custom-suffix=dolores Only applies to Option.CUSTOM. option=gubergren Suffix option. About Cursors The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up. Optional Output Flags The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output. Optional General Properties The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Create"},{"location":"short-links_create/#scopes","text":"You will need authorization for the https://www.googleapis.com/auth/firebase scope to make a valid call. If unset, the scope for this method defaults to https://www.googleapis.com/auth/firebase . You can set the scope for this method like this: firebasedynamiclinks1 --scope <scope> short-links create ...","title":"Scopes"},{"location":"short-links_create/#required-request-value","text":"The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely. For example, a structure like this: CreateShortDynamicLinkRequest: dynamic-link-info: analytics-info: google-play-analytics: gclid: string utm-campaign: string utm-content: string utm-medium: string utm-source: string utm-term: string itunes-connect-analytics: at: string ct: string mt: string pt: string android-info: android-fallback-link: string android-link: string android-min-package-version-code: string android-package-name: string desktop-info: desktop-fallback-link: string domain-uri-prefix: string dynamic-link-domain: string ios-info: ios-app-store-id: string ios-bundle-id: string ios-custom-scheme: string ios-fallback-link: string ios-ipad-bundle-id: string ios-ipad-fallback-link: string ios-minimum-version: string link: string navigation-info: enable-forced-redirect: boolean social-meta-tag-info: social-description: string social-image-link: string social-title: string long-dynamic-link: string sdk-version: string suffix: custom-suffix: string option: string can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time. -r .dynamic-link-info.analytics-info.google-play-analytics gclid=voluptua. Deprecated; FDL SDK does not process nor log it. utm-campaign=amet. Campaign name; used for keyword analysis to identify a specific product promotion or strategic campaign. utm-content=consetetur Campaign content; used for A/B testing and content-targeted ads to differentiate ads or links that point to the same URL. utm-medium=diam Campaign medium; used to identify a medium such as email or cost-per-click. utm-source=dolor Campaign source; used to identify a search engine, newsletter, or other source. utm-term=et Campaign term; used with paid search to supply the keywords for ads. ..itunes-connect-analytics at=et Affiliate token used to create affiliate-coded links. ct=sadipscing Campaign text that developers can optionally add to any link in order to track sales from a specific marketing campaign. mt=stet iTune media types, including music, podcasts, audiobooks and so on. pt=dolor Provider token that enables analytics for Dynamic Links from within iTunes Connect. ...android-info android-fallback-link=duo Link to open on Android if the app is not installed. android-link=vero If specified, this overrides the \u2018link\u2019 parameter on Android. android-min-package-version-code=vero Minimum version code for the Android app. If the installed app\u2019s version code is lower, then the user is taken to the Play Store. android-package-name=invidunt Android package name of the app. ..desktop-info desktop-fallback-link=stet Link to open on desktop. .. domain-uri-prefix=vero E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More examples can be found in description of getNormalizedUriPrefix in j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain is this field is missing dynamic-link-domain=elitr Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl Learn more on how to set up Dynamic Link domain associated with your Firebase project. Required if missing domain_uri_prefix. ios-info ios-app-store-id=lorem iOS App Store ID. ios-bundle-id=diam iOS bundle ID of the app. ios-custom-scheme=no Custom (destination) scheme to use for iOS. By default, we\u2019ll use the bundle ID as the custom scheme. Developer can override this behavior using this param. ios-fallback-link=ipsum Link to open on iOS if the app is not installed. ios-ipad-bundle-id=accusam iPad bundle ID of the app. ios-ipad-fallback-link=takimata If specified, this overrides the ios_fallback_link value on iPads. ios-minimum-version=consetetur iOS minimum version. .. link=voluptua. 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 . Required. navigation-info enable-forced-redirect=false If this option is on, FDL click will be forced to redirect rather than show an interstitial page. ..social-meta-tag-info social-description=erat A short description of the link. Optional. social-image-link=consetetur An image url string. Optional. social-title=amet. Title to be displayed. Optional. ... long-dynamic-link=sed Full long Dynamic Link URL with desired query parameters specified. For example, \"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\", Learn more . sdk-version=takimata Google SDK version. Version takes the form \"$major.$minor.$patch\" suffix custom-suffix=dolores Only applies to Option.CUSTOM. option=gubergren Suffix option.","title":"Required Request Value"},{"location":"short-links_create/#about-cursors","text":"The cursor position is key to comfortably set complex nested structures. The following rules apply: The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o . The cursor position is set relative to the top-level structure if it starts with . , e.g. -r .s.s You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar . You can move the cursor one level up by using .. . Each additional . moves it up one additional level. E.g. ... would go three levels up.","title":"About Cursors"},{"location":"short-links_create/#optional-output-flags","text":"The method's return value a JSON encoded structure, which will be written to standard output by default. -o out out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.","title":"Optional Output Flags"},{"location":"short-links_create/#optional-general-properties","text":"The following properties can configure any call, and are not specific to this method. -p $-xgafv=string V1 error format. -p access-token=string OAuth access token. -p alt=string Data format for response. -p callback=string JSONP -p fields=string Selector specifying which fields to include in a partial response. -p key=string 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. -p oauth-token=string OAuth 2.0 token for the current user. -p pretty-print=boolean Returns response with indentations and line breaks. -p quota-user=string 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. -p upload-type=string Legacy upload protocol for media (e.g. \"media\", \"multipart\"). -p upload-protocol=string Upload protocol for media (e.g. \"raw\", \"multipart\").","title":"Optional General Properties"}]}