Skip to content

Users YouTube

Ross Scroggs edited this page Nov 23, 2023 · 3 revisions

Users - YouTube

API documentation

Notes

To use these commands you must add the 'YouTube API' to your project and update your service account authorization.

gam update project
gam user [email protected] update serviceaccount

Definitions

<BCP47LanguageCode> ::=
        ar-sa| # Arabic Saudi Arabia
        cs-cz| # Czech Czech Republic
        da-dk| # Danish Denmark
        de-de| # German Germany
        el-gr| # Modern Greek Greece
        en-au| # English Australia
        en-gb| # English United Kingdom
        en-ie| # English Ireland
        en-us| # English United States
        en-za| # English South Africa
        es-es| # Spanish Spain
        es-mx| # Spanish Mexico
        fi-fi| # Finnish Finland
        fr-ca| # French Canada
        fr-fr| # French France
        he-il| # Hebrew Israel
        hi-in| # Hindi India
        hu-hu| # Hungarian Hungary
        id-id| # Indonesian Indonesia
        it-it| # Italian Italy
        ja-jp| # Japanese Japan
        ko-kr| # Korean Republic of Korea
        nl-be| # Dutch Belgium
        nl-nl| # Dutch Netherlands
        no-no| # Norwegian Norway
        pl-pl| # Polish Poland
        pt-br| # Portuguese Brazil
        pt-pt| # Portuguese Portugal
        ro-ro| # Romanian Romania
        ru-ru| # Russian Russian Federation
        sk-sk| # Slovak Slovakia
        sv-se| # Swedish Sweden
        th-th| # Thai Thailand
        tr-tr| # Turkish Turkey
        zh-cn| # Chinese China
        zh-hk| # Chinese Hong Kong
        zh-tw  # Chinese Taiwan

<YouTubeChannelID> ::= <String>
<YouTubeChannelIDList> ::= "<YouTubeChannelID>(,<YouTubeChannelID>)*"

<YouTubeChannelFieldName> ::=
        brandingsettings|
        contentdetails|
        contentownerdetails|
        id|
        localizations|
        snippet|
        statistics|
        status|
        topicdetails
<YouTubeChannelFieldNameList> ::= "<YouTubeChannelFieldName>(,<YouTubeChannelFieldName>)*"

Display Selected YouTube Channels

Display YouTube channels selected by ID.

gam <UserTypeEntity> show youtubechannels
        (mine|
         (ids|channels <YouTubeChannelIDList>)|
         (forusername <String>)|
         (managedbyme <String>))
        [languagecode <BCP47LanguageCode>]
        [allfields|(fields <YouTubeChannelFieldNameList>)]
        [formatjson]

By default, only the YouTube channel ID is displayed; use allfields|fields to select additional fields for display.

By default, Gam displays the YouTube channels as an indented list of keys and values.

  • formatjson - Display the YouTube channels in JSON format
gam <UserTypeEntity> print youtubechannels [todrive <ToDriveAttribute>*]
        (mine|
         (ids|channels <YouTubeChannelIDList>)|
         (forusername <String>)|
         (managedbyme <String>))
        [languagecode <BCP47LanguageCode>]
        [allfields|(fields <YouTubeChannelFieldNameList>)]
        [formatjson [quotechar <Character>]]

By default, only the YouTube channel ID is displayed; use allfields|fields to select additional fields for display.

By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,

  • formatjson - Display the fields in JSON format.

By default, when writing CSV files, Gam uses a quote character of double quote ". The quote character is used to enclose columns that contain the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled. When using the formatjson option, double quotes are used extensively in the data resulting in hard to read/proces output. The quotechar <Character> option allows you to choose an alternate quote character, single quote for instance, that makes for readable/procesable output. quotechar defaults to gam.cfg/csv_output_quote_char. When uploading CSV files to Google, double quote " should be used.

Display Owned YouTube Channels

Display YouTube channels owned by a user.

gam <UserTypeEntity> show youtubechannels
        [languagecode <BCP47LanguageCode>]
        [allfields|(fields <YouTubeChannelFieldNameList>)]
        [formatjson]

By default, only the YouTube channel ID is displayed; use allfields|fields to select additional fields for display.

By default, Gam displays the YouTube channels as an indented list of keys and values.

  • formatjson - Display the YouTube channels in JSON format
gam <UserTypeEntity> print youtubechannels [todrive <ToDriveAttribute>*]
        (mine|
         (ids|channels <YouTubeChannelIDList>)|
         (forusername <String>)|
         (managedbyme <String>))
        [languagecode <BCP47LanguageCode>]
        [allfields|(fields <YouTubeChannelFieldNameList>)]
        [formatjson [quotechar <Character>]]

By default, only the YouTube channel ID is displayed; use allfields|fields to select additional fields for display.

By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,

  • formatjson - Display the fields in JSON format.

By default, when writing CSV files, Gam uses a quote character of double quote ". The quote character is used to enclose columns that contain the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled. When using the formatjson option, double quotes are used extensively in the data resulting in hard to read/proces output. The quotechar <Character> option allows you to choose an alternate quote character, single quote for instance, that makes for readable/procesable output. quotechar defaults to gam.cfg/csv_output_quote_char. When uploading CSV files to Google, double quote " should be used.

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally