Content last updated 2026-07-14

アプリ

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 など）がある場合にのみ実施してください。存在しない場合は、先に作成し、対応を開始する前に標準プロセスを通過させてください。

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 など）がある場合にのみ実施してください。存在しない場合は、先に作成し、対応を開始する前に標準プロセスを通過させてください。
バージョニングの情報に従ってください

すでにインストールされているアプリの更新は、対応する同期リポジトリが制御するため、かなり簡単です。アプリを更新するには、アプリの同期リポジトリで MR を作成する必要があります。正確な変更内容は、リクエスト自体によって異なります。

ピアが MR をレビューして承認した後、MR をマージできます。次のデプロイ時に Zendesk と同期されます。

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

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

アプリを無効化する

警告

対応するリクエスト Issue（Feature Request、Administrative、Bug など）がある場合にのみ実施してください。存在しない場合は、先に作成し、対応を開始する前に標準プロセスを通過させてください。
アプリを無効化する場合は、その同期メカニズムを制御するスケジュールパイプラインを無効にする必要があります

アプリを無効化するには:

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

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

警告

対応するリクエスト Issue（Feature Request、Administrative、Bug など）がある場合にのみ実施してください。存在しない場合は、先に作成し、対応を開始する前に標準プロセスを通過させてください。
無効化されたアプリのみをアンインストールしてください

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

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

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

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

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

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

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

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

アプリ