Content last updated 2026-05-26

アプリ

Zendesk アプリに関するドキュメント

このガイドでは、GitLab における Zendesk アプリの情報と管理について説明します。

現在使用中のアプリの一覧:

開発者は開発ドキュメントを確認してください。

管理者は管理者タスクセクションを確認してください。

技術的な詳細

デプロイメントタイプ: Standard
グループ同期リポジトリは以下の場所にあります:
- Zendesk Global
- Zendesk US Government

Zendesk アプリを理解する

Zendesk アプリとは

Zendesk アプリは、Zendesk の場所で実行されるアプリケーション（HTML/CSS/JS で書かれたもの）です。何をするか、どのように行うかはアプリケーションごとに大きく異なります。アプリケーションは多くの場所で実行できますが、伝統的な場所は次のとおりです:

チケットサイドバー
ユーザーサイドバー
組織サイドバー
ナビゲーションバー
バックグラウンド

アプリケーションの場所に関する詳細は、Zendesk Developer Manifest Reference ドキュメントで確認できます。

Zendesk アプリケーションは通常、次の 2 つの領域のいずれかから来ます:

Zendesk Marketplace
社内開発

私たちのアプリの管理方法

Zendesk は UI を通じてアプリを完全に管理する方法を提供していますが、私たちはよりバージョン管理されたメソドロジーを採用しています。これにより、定められたレビュープロセス、必要に応じたロールバック実行などが可能になります。

そのため、私たちは同期リポジトリと管理コンテンツリポジトリを利用しています。

管理者タスク

バージョニング

Zendesk アプリのバージョンには、以下のスタイルを使用します:

Major.Minor

これは（Patch 番号なしの）セマンティックバージョニングに従います。そのため、通常の Minor と Patch の定義を 1 つに統合する必要があります。

一般的なルールとして:

マイナーバージョンの変更（Minor 番号をインクリメント）:
- バグ修正と訂正
- 小規模な UI の改善
- パフォーマンスの最適化
- 小規模な機能追加
メジャーバージョンの変更（Major をインクリメント、Minor を 0 にリセット）:
- 機能への破壊的変更
- 大規模な再設計または書き直し
- 重要な新機能
- 新しい権限を必要とする変更

例として:

アプリバージョン 2.9 で小規模な変更を行うと、新しいバージョンは 2.10 になります
アプリバージョン 2.9 で大規模な変更を行うと、新しいバージョンは 3.0 になります

アプリをインストールする

情報

これは Zendesk へのアプリのインストールについて説明します。
- アプリプロジェクトを作成する必要がある場合は、プロジェクトのセットアップを参照してください
- アプリを開発する必要がある場合は、アプリ開発を参照してください
Zendesk Marketplace からアプリをインストールする場合は、そのアプリのページの指示を参照してください。

警告

これは、対応する Issue（Feature Request、Administrative、Bug 等）がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し（標準プロセスに従って処理されるのを待ってから）作業してください。

Zendesk にアプリをインストールするには、まずアプリをパッケージ化する必要があります。これを行うには、プロジェクトリポジトリ内で（CLI 経由で）次のコマンドを実行します:

zip -r data/application.zip assets manifest.json translations

その後、data/application.zip を使って次のようにして Zendesk にアプリをアップロード（しインストール）します:

Zendesk インスタンスの管理ダッシュボードに移動します
Apps and integrations > Apps > Zendesk Support apps に移動します
ページの右上にある Upload private app をクリックします
アプリの名前（アプリの manifest.json ファイルに記載されている通り）を入力します
Choose File をクリックして、先ほど作成した data/application.zip ファイルを選択します
Upload をクリックします

そこから、（インストール後）アプリのページに移動し、制限、パラメータなどを設定できます。

アプリを更新する

警告

これは、対応する Issue（Feature Request、Administrative、Bug 等）がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し（標準プロセスに従って処理されるのを待ってから）作業してください。
バージョニング情報に従うようにしてください

すでにインストール済みのアプリの更新は、対応する同期リポジトリがそれを制御しているため、はるかに簡単です。アプリを更新するには、アプリの同期リポジトリで MR を作成する必要があります。具体的な変更内容は、依頼自体に依存します。

ピアによるレビューと承認の後、MR をマージできます。次のデプロイメントが行われる際に、Zendesk に同期されます。

サンドボックスでインストール済みアプリを強制更新する

サンドボックスでアプリを強制更新する必要がある場合（特に開発中）、プロジェクトリポジトリ内で（CLI 経由で）./bin/sync_sandbox force コマンドを実行します。

アプリを非アクティブ化する

警告

これは、対応する Issue（Feature Request、Administrative、Bug 等）がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し（標準プロセスに従って処理されるのを待ってから）作業してください。
アプリを非アクティブ化する場合は、その同期メカニズムを制御するスケジュールパイプラインを無効化する必要があります

アプリを非アクティブ化するには:

Zendesk インスタンスの管理ダッシュボードに移動します
Apps and integrations > Apps > Zendesk Support apps に移動します
対象のアプリにカーソルを合わせ、下矢印をクリックします
Enabled オプションの下のスライダーをクリックします

アプリをアンインストールする

警告

これは、対応する Issue（Feature Request、Administrative、Bug 等）がある場合にのみ実施してください。存在しない場合は、まず Issue を作成し（標準プロセスに従って処理されるのを待ってから）作業してください。
アンインストールするのは、必ず非アクティブ化されたアプリのみにしてください

アプリをアンインストールするには:

Zendesk インスタンスの管理ダッシュボードに移動します
Apps and integrations > Apps > Zendesk Support apps に移動します
対象のアプリにカーソルを合わせ、下矢印をクリックします
Uninstall をクリックします

例外デプロイメントを実行する

アプリの例外デプロイメントを実行するには、対象のアプリプロジェクトに移動し、スケジュールパイプラインのページに移動して、同期項目の再生ボタンをクリックします。これにより、アプリの同期ジョブがトリガーされます。

よくある問題とトラブルシューティング

マージ後にアプリの変更が反映されない

アプリは Standard デプロイメントタイプに従うため、通常のデプロイメントサイクル（または例外デプロイメントが行われたとき）にのみデプロイされます。

ページのソースコードを見る - ページの編集 - please contribute.

アプリ