bitly_create_bitlink: Create a short Bitlink

In urlshorteneR: R Wrapper for the 'Bit.ly' and 'Is.gd'/'v.gd' URL Shortening Services

Create a short Bitlink

Description

See https://dev.bitly.com/docs/getting-started/rate-limits and https://dev.bitly.com/api-reference/#createFullBitlink Convert a long url to a Bitlink and set additional parameters.

Usage

bitly_create_bitlink(
  long_url = NULL,
  domain = "bit.ly",
  title = NULL,
  tags = NULL,
  group_guid = NULL,
  deeplinks_list = list(app_uri_path = NULL, install_type = NULL, install_url = NULL,
    app_id = NULL),
  showRequestURL = FALSE
)

Arguments

long_url	- required, a long URL to be shortened (example: https://www.idnes.cz). Must contain http/https
domain	- (optional) the short domain to use; either bit.ly, j.mp, or bitly.com or a custom short domain. The default for this parameter is the short domain selected by each user in their bitly account settings. Passing a specific domain via this parameter will override the default settings.
title	- title of the bitlink
tags	- Array of string, use e.g. c("test1", "test2")
group_guid	- a GUID for a Bitly group
deeplinks_list	- a list containing parameters below
showRequestURL	- show URL which has been build and requested from server. For debug purposes.
app_uri_path	- app_uri_path
install_type	- install_type
install_url	- install_url
app_id	- app_id

Value

id - a short bitly identifier for long_url which is unique to the given account.

long_url - This may not always be equal to the URL requested, as some URL normalization may occur (e.g., due to encoding differences, or case differences in the domain). This long_url will always be functionally identical the the request parameter.

link - an bitly id with http(s) prefix

Note

Look in the vignette for bulk shortening of URLs. Each call of this function == 1 API call. Take that into consideration due to limits etc.

The bitly API does not support shortening more than one long URL with a single API call. Meaning 1 Long URL = 1 Function call.

Long URLs should be URL-encoded. You can not include a longUrl in the request that has &, ?, #, or other reserved parameters without first encoding it.

The default value for the domain parameter is selected by each user from within their bitly account settings at <https://app.bitly.com/settings/api/>.

Long URLs should not contain spaces: any longUrl with spaces will be rejected. All spaces should be either percent encoded spaces are all indications of errors. Please remember to strip leading and trailing whitespace from any user input before shortening.

Examples

## Not run: 
bitly_create_bitlink(long_url = "http://slovnik.seznam.cz/")

## End(Not run)

urlshorteneR documentation built on Aug. 22, 2022, 9:08 a.m.