feat(user/get_ytpljson.sh):Add script to get YT playlist metadata

[BK-2020-03.git] / doc / user / get_ytpljson.sh.org

diff --git a/doc/user/get_ytpljson.sh.org b/doc/user/get_ytpljson.sh.org
new file mode 100644 (file)
index 0000000..5136424
--- /dev/null
+++ b/doc/user/get_ytpljson.sh.org
@@ -0,0 +1,36 @@
+* get_ytpljson.sh Information
+
+#+TITLE: get_ytpljson.sh Information
+#+AUTHOR: Steven Baltakatei Sandoval
+#+DATE:2023-02-20
+#+EMAIL:baltakatei@gmail.com
+#+LANGUAGE: en
+#+OPTIONS: toc:nil
+
+Created by [[https://baltakatei.com][Steven Baltakatei Sandoval]] on
+2023-02-20T12:38+00
+under a [[https://creativecommons.org/licenses/by-sa/4.0/][CC BY-SA 4.0]] (🅭🅯🄎4.0) license and last updated on
+2023-02-20T12:38+00.
+
+** Summary
+This script downloads and saves YouTube playlist metadata as a JSON
+file in the current working directory.
+
+** Versions
+| Version | Description                                     |
+|---------+-------------------------------------------------|
+|   0.0.1 | Initial version compatible with YouTUbe API v3. |
+|         |                                                 |
+
+** Background
+Google provides an API for downloading playlist metadata in resposne
+to receiving a correctly formatted URL containing the playlist ID and
+an API key.
+
+** References
+- "Obtaining authorization credentials"
+  https://developers.google.com/youtube/registering_an_application
+- "Implementation: Playlists"
+  https://developers.google.com/youtube/v3/guides/implementation/playlists
+- "Implementation: Pagination",
+  https://developers.google.com/youtube/v3/guides/implementation/pagination