Matomoユーザー会 - 高機能アクセス解析ソフト Matomo Analyrics の日本ユーザー会ホームページです
  • twitter
  • facebook
  • youtube
  • linkedin
  • Matomo(Piwik)とは?
    • Matomo(Piwik)解析機能一覧
    • ログアナリティクス
    • ロードマップ
    • ユーザーガイド
    • Matomo(Piwik)関連の動画
    • Matomo(Piwik)紹介VPS
  • ユーザー会について
    • お問合わせ
  • ニュース
    • トピックス
    • お知らせ
  • イベント
    • 開発者インタビュー
  • 技術文書
    • FAQ
    • リリース情報
    • 導入ガイド
トピックス

Home ニュース トピックス Piwikマーケットプレースであなたのプラグインやテーマを公開する方法 Piwikのプラットフォームの紹介

Piwikマーケットプレースであなたのプラグインやテーマを公開する方法 Piwikのプラットフォームの紹介

2014年 9月 29日
  • それではブログシリーズの新しい記事、Piwik プラットフォームの機能を紹介します。この数週間にわたって、既にプラグインやテーマを作成する方法の基本を紹介してきました。今回はすべてのPiwikのユーザーと共有するPiwikマーケットプレイスで、プラグインやテーマを公開する方法を学びます。

    Piwikマーケットプレイスとは

    Marketplaceは、Piwikで使用できるすべてのプラグインやテーマのショーケースです。セッティング -> マーケットプレイスからスタンドアロンのウェブサイト上またはPiwik自体のいずれかで、それらを閲覧することができます。それらはワンクリックでインストール及びアップデートできます。とても簡単です!
    一部のプラグインはPiwik及び InnoCraftによって提供されますが、ほとんどはコミュニティによって作成、維持されています。マーケットプレイスでのプラグインやテーマの配布はどなたでも大歓迎です。

    前提条件

    マーケットプレース上でプラグインを公開するには以下の条件を満たす必要があります:

    • プラグイン名は他のプラグインで使用されていないものに限る
    • プラグインのコードはパブリックGitHubのリポジトリでホストされている
    • GitHub サービス「Piwik プラグイン」このリポジトリに対しては有効になっている(Repository Settings => Webhooks & Services => Add Service)
    • このリポジトリのアクセス許可をプッシュ
    • 無料で公開すること
    • ライセンスは GNU General Public License v3 またはそれ以降のバージョンとの互換性があること

    プラグインのルールの一覧

    ベストプラクティス

    実際にプラグインを配布する前に、そのプラグインがマーケットプレース上での有用性、また、将来のユーザーのための有用な情報を提供することを確認し、ベストプラクティスのいくつかに従うことをお勧めします。プラグインを生成するため、コンソールを使用している場合、必要なファイルが既に作成されています。

    判り易い説明を入力します。

    作成したプラグインのルートに README.md という名前のファイルがあることを確認します。
    Description, FAQ, Changelog and Support:マーケットプレイスにプラグインを準備するとき、このファイルの4つのセクションを検索します。それぞれ任意ですが、少なくとも、セクション Description と Support には ## を付けて登録することをお勧めします。これらのセクション外に readme ファイルのすべてのコンテンツは、マーケットプ レースでは表示されません。

    # Piwik Plugin Name
    
    ## Description
    
    Add your plugin description here.
    
    ## Support
    
    Please direct any feedback to hello@piwik.org. 
    If you experience any issues feel free to file an issue at https://github.com/piwik/piwik/issues .
    

    良い例は、プラグインCustomAlertsのREADME.mdおよび関連CustomAlertsプラグインのページで見ることができます。

    スクリーンショットを登録します

    これはマーケットプレイスでのあなたの外観を向上させ、多くユーザーがあなたのプラグインをインストールするようになるでしょう。screenshotsフォルダ内に、「PNG」または「JPG」ファイルを配置するのと同じくらい簡単です。アンダースコアは空白文字に置き換え、UI の各イメージのファイル名が表示されます。このように素敵な説明を入力できます。それがどのように動作するかを確認するプラグインCustomAlertsでご覧になれます。

    連絡先の詳細を入力します

    あなたの連絡先の詳細は、プラグインのルートフォルダのplugin.jsonファイルで指定します。少なくとも 1 人の著者と自分のホームページにリンクを入力することが必要です。ウェブサイトを持っていない場合 GitHub のプロフィールへのリンクを使用できます。これにより、ユーザーが問題を報告したい場合や、またはあなたの素晴らしい仕事に感謝したい場合はご連絡できます。
    例 plugin.json は、このようになります:

    {
        "name": "MyPluginName",
        "homepage": "http://piwik.org",
        "authors": [
            {
                "name": "Piwik",
                "email": "hello@piwik.org",
                "homepage": "http://piwik.org"
            }
        ],
        "support": {
          "email": "hello@piwik.org",
          "issues": "https://github.com/piwik/piwik/issues",
          "forum": "http://forum.piwik.org",
          "wiki": "https://github.com/piwik/piwik/wiki",
          "irc": "#piwik-dev"
        } 
    }
    

    ライセンスを選択します。

    あなたとユーザーにとって最適なライセンスを選択することが重要です。Piwik マーケットプレイス経由でプラグインを配布するには、ライセンスは GNU General Public License v3 またはそれ以降のバージョンとの互換性がある必要があります。プラグインのライセンスを指定しない場合は、以降GPLv3を使用するプラグインとみなされます。ライセンスはプロパティlicenseを使用してplugin.jsonファイルで指定する必要があります。

    {
        "name": "MyPluginName",
        "license": "GPL v3+"
    }
    

    寄付のリンクを提供します。

    plugin.json ファイルで PayPal、Flattr、Bitcoin の寄付リンクまたは電子メールを定義できます。あなたの仕事を愛するユーザーは、プラグインのページから直接お金を寄付することができます。

    {
        "name": "MyPluginName"
        "donate": {
            "paypal": "sponsor@piwik.org",
            "flattr": "https://flattr.com/profile/piwik",
            "bitcoin": "1234567890"
        }
    }
    

    プラグインの最初のバージョンを発行する方法

    マーケットプレイスでのプラグインの公開をできるだけ簡単にしようとしています。だからこそ我々 は、任意のログインまたはパッケージングを必要としません。プラグインを公開するには、新しいタグを作成する必要があり、数分以内にプラグインが何十万ものPiwikにインストールすることができるようになります。

    プラグインにタグを付けるには、次の2つの提案のいずれかを使用してください。

    コマンドラインを使用

    git tag 0.1.0 && git push --tags
    

    ここで”0.1.0″ は、タグの名前です。任意のタグ名を使用できますが plugin.json ファイルで定義されている現在のバージョン番号を使用するお勧めします。

    GitHub の UI を使用

    GitHub のクリックで新しいバージョンのリリースにタグを付けるには => Draft a new release
    github_distribute_plugin_1

    これで、タグ名(バージョン)を押し、この画面のように「Publish release」を入力できます。以上です!
    github_distribute_plugin_2

    プラグインのアップデートを提供する方法

    アップデートを提供するには、専用のファイルplugin.jsonにバージョン番号を増加させ、前のセクションで説明したように別のタグを作成する必要があります。新しいプラグインの更新が数分程度以内にマーケットプレイスに表示されます。更新は各PiwikのサーバとPiwik内の更新数時間ごとにチェックしており、自分自身が表示されるまでにはいくらか時間がかかる場合があります。

    情報の完全なリストは、Piwik Developer Zone でプラグインの配布ガイドを参照してください。

    APIまたはDeveloper Zoneにおける手引きに関してのフィードバックはお気軽にお寄せ下さい。


    thomas_s-150x150Thomas Steur

    Thomasはドイツの名門ソフトウェア会社で働くソフトウェア·エンジニアです。彼は何千人ものユーザーが数十週に渡って使用している当社のPiwik モバイル アプリを作成し、現在の開発リーダーでもあります。Thomasは常により良いPiwikのモバイルを作るために新しいアイデアを試みています。もしアプリ使用しているのであれば、沢山の提案やアイデアのフィードバックをお願いします。

コメントを残す - Cancel Reply

日本Matomo(Piwik)ユーザー会
  • HOME
  • Matomo(Piwik)とは?
  • Matomo(Piwik)日本ユーザー会について
  • Matomo(Piwik)関連の動画
  • お問合わせ
保守
  •    
開発者インタビュー
  • Matthieu Aubry氏
  • Adrian Speyer氏
  • Thomas Steur氏
  • Benaka氏
  • Julien Moumné氏
最近の投稿
  • Google Analytics 4とGDPR:知っておくべきことすべて
  • Matomo 4.10.0
  • GoogleAnalyticsからMatomoに移行する7つの理由
  • 知っておくべき10の主要なGoogleAnalyticsの制限
  • Matomo 4.9.1
最近のコメント
  • Piwik Mobile 1.9.4 に piwik_admin より
  • Piwik Mobile 1.9.4 に kiyoji より
アーカイブ
  • 2022年5月
  • 2022年4月
  • 2022年3月
  • 2022年2月
  • 2022年1月
  • 2021年12月
  • 2021年11月
  • 2021年10月
  • 2021年9月
  • 2021年8月
  • 2021年7月
  • 2021年6月
  • 2021年3月
  • 2021年1月
  • 2020年12月
  • 2020年11月
  • 2020年10月
  • 2020年9月
  • 2020年8月
  • 2020年7月
  • 2020年6月
  • 2020年5月
  • 2020年4月
  • 2020年3月
  • 2020年2月
  • 2020年1月
  • 2019年12月
  • 2019年11月
  • 2019年10月
  • 2019年8月
  • 2019年7月
  • 2019年6月
  • 2019年5月
  • 2019年4月
  • 2019年3月
  • 2019年2月
  • 2019年1月
  • 2018年12月
  • 2018年11月
  • 2018年10月
  • 2018年9月
  • 2018年7月
  • 2018年6月
  • 2018年5月
  • 2018年4月
  • 2018年3月
  • 2018年1月
  • 2017年12月
  • 2017年11月
  • 2017年10月
  • 2017年9月
  • 2017年7月
  • 2017年6月
  • 2017年5月
  • 2017年4月
  • 2017年3月
  • 2017年2月
  • 2017年1月
  • 2016年12月
  • 2016年11月
  • 2016年10月
  • 2016年9月
  • 2016年8月
  • 2016年6月
  • 2016年5月
  • 2016年4月
  • 2016年2月
  • 2016年1月
  • 2015年12月
  • 2015年11月
  • 2015年10月
  • 2015年9月
  • 2015年8月
  • 2015年7月
  • 2015年6月
  • 2015年5月
  • 2015年4月
  • 2015年3月
  • 2015年2月
  • 2015年1月
  • 2014年12月
  • 2014年11月
  • 2014年10月
  • 2014年9月
  • 2014年8月
  • 2014年7月
  • 2014年6月
  • 2014年5月
  • 2014年4月
  • 2014年3月
  • 2014年2月
  • 2014年1月
  • 2013年12月
  • 2013年11月
  • 2013年10月
  • 2013年9月
  • 2013年8月
  • 2013年7月
  • 2013年6月
  • 2013年5月
  • 2013年4月
  • 2013年3月
  • 2013年2月
  • 2013年1月
  • 2012年12月
  • 2012年11月
  • 2012年10月
  • 2012年9月
  • 2012年8月
  • 2012年7月
カテゴリー
  • FAQ
  • How To
  • Matomo(Piwik)とは?
  • Matomo(Piwik)の特徴
  • お知らせ
  • アップデート
  • イベント
  • インストール
  • トピックス
  • ニュース
  • ブログ
  • リリース情報
  • 初めてのMatomo(Piwik)
  • 導入ガイド
  • 技術文書
  • 機能説明
日本Matomo(Piwik)ユーザー会
  • HOME
  • Matomo(Piwik)とは?
  • Matomo(Piwik)日本ユーザー会について
  • ニュース
  • Matomo(Piwik)関連の動画
Matomo(Piwik)関連
  • Matomo(Piwik)公式サイト(英語)
  • 公式ブログ(英語)
  • フォーラム(英語)
  • 本家Facebookページ(英語)
  • Matomo(Piwik)Japan Facebookページ
  • Matomo(Piwik)紹介VPS
その他
  • Matomo(Piwik)のクイックインストール
  • オンラインデモ
  • 開発者インタビュー

Matomo Analytics 日本ユーザー会
このホームページはMatomo JA ユーザー会運営事務局が運営しています
Copyright (c) 2012 Matomo Analytics Users Japan. All rights reserved.
Bandwidth and hardware provided by DATA-TREK,Inc.