GitHub

概要

getProjectData メソッドは、翻訳プロジェクトの名称、組織、デフォルトの locale、現在設定されている対象の locales など、プロジェクトに関する詳細情報を取得します。このメソッドは、プロジェクト設定の把握や構成の検証に役立ちます。

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const projectData = await gt.getProjectData('project-123');
console.log(`プロジェクト: ${projectData.name}`);
console.log(`既定のロケール: ${projectData.defaultLocale}`);
console.log(`対象ロケール: ${projectData.currentLocales.join(', ')}`);

リファレンス

パラメーター

名称	型	説明
`projectId`	`string`	取得対象のプロジェクトを特定する一意の識別子
`options?`	`{ timeout?: number }`	リクエストのためのオプション設定

オプション

名称	型	説明
`timeout?`	`number`	リクエストのタイムアウト（ミリ秒）

戻り値

Promise<ProjectData> - プロジェクトの情報と構成を含みます。

type ProjectData = {
  id: string;
  名称: string;
  orgId: string;
  既定のロケール: string;
  対応ロケール: string[];
}

プロパティ	型	説明
`id`	`string`	プロジェクトの一意な識別子
`name`	`string`	人間が判読しやすいプロジェクトの名称
`orgId`	`string`	当該プロジェクトを所有する組織の識別子
`defaultLocale`	`string`	プロジェクトの既定のソースロケール
`currentLocales`	`string[]`	現在構成されている対象ロケールの配列

例

基本的な使い方

index.ts

import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key'
});

async function getProjectInfo(projectId: string) {
  try {
    const project = await gt.getProjectData(projectId);
    
    console.log('=== プロジェクト情報 ===');
    console.log(`ID: ${project.id}`);
    console.log(`名称: ${project.name}`);
    console.log(`組織: ${project.orgId}`);
    console.log(`既定のロケール: ${project.defaultLocale}`);
    console.log(`対象ロケール: ${project.currentLocales.join(', ')}`);
    
    return project;
  } catch (error) {
    console.error(`プロジェクト ${projectId} の取得に失敗しました:`, error);
    throw error;
  }
}

const projectInfo = await getProjectInfo('my-project-123');

注意事項

このメソッドはプロジェクト情報への読み取り専用アクセスを提供します。プロジェクト設定の変更はdashboardで行ってください
このメソッドの利用には有効なプロジェクトIDが必要です。提供されたAPIキーで当該プロジェクトにアクセスできる必要があります
プロジェクトデータには、ソースおよびターゲットの両方のlocale設定が含まれます
currentLocales 配列は、そのプロジェクトで設定されているすべてのターゲットlocaleを表します
翻訳ワークフローを開始する前に、プロジェクト設定の妥当性確認にこのメソッドを使用してください

次のステップ

プロジェクトのセットアップが必要かどうかは shouldSetupProject を参照
プロジェクトのセットアップを開始するには setupProject を参照
翻訳ジョブを開始するには enqueueFiles を参照
ファイル単位の情報については querySourceFile を参照

概要

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const projectData = await gt.getProjectData('project-123');
console.log(`プロジェクト: ${projectData.name}`);
console.log(`既定のロケール: ${projectData.defaultLocale}`);
console.log(`対象ロケール: ${projectData.currentLocales.join(', ')}`);

リファレンス

パラメーター

名称	型	説明
`projectId`	`string`	取得対象のプロジェクトを特定する一意の識別子
`options?`	`{ timeout?: number }`	リクエストのためのオプション設定

オプション

名称	型	説明
`timeout?`	`number`	リクエストのタイムアウト（ミリ秒）

戻り値

Promise<ProjectData> - プロジェクトの情報と構成を含みます。

type ProjectData = {
  id: string;
  名称: string;
  orgId: string;
  既定のロケール: string;
  対応ロケール: string[];
}

プロパティ	型	説明
`id`	`string`	プロジェクトの一意な識別子
`name`	`string`	人間が判読しやすいプロジェクトの名称
`orgId`	`string`	当該プロジェクトを所有する組織の識別子
`defaultLocale`	`string`	プロジェクトの既定のソースロケール
`currentLocales`	`string[]`	現在構成されている対象ロケールの配列

例

基本的な使い方

index.ts

import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key'
});

async function getProjectInfo(projectId: string) {
  try {
    const project = await gt.getProjectData(projectId);
    
    console.log('=== プロジェクト情報 ===');
    console.log(`ID: ${project.id}`);
    console.log(`名称: ${project.name}`);
    console.log(`組織: ${project.orgId}`);
    console.log(`既定のロケール: ${project.defaultLocale}`);
    console.log(`対象ロケール: ${project.currentLocales.join(', ')}`);
    
    return project;
  } catch (error) {
    console.error(`プロジェクト ${projectId} の取得に失敗しました:`, error);
    throw error;
  }
}

const projectInfo = await getProjectInfo('my-project-123');

注意事項

このメソッドはプロジェクト情報への読み取り専用アクセスを提供します。プロジェクト設定の変更はdashboardで行ってください
このメソッドの利用には有効なプロジェクトIDが必要です。提供されたAPIキーで当該プロジェクトにアクセスできる必要があります
プロジェクトデータには、ソースおよびターゲットの両方のlocale設定が含まれます
currentLocales 配列は、そのプロジェクトで設定されているすべてのターゲットlocaleを表します
翻訳ワークフローを開始する前に、プロジェクト設定の妥当性確認にこのメソッドを使用してください

次のステップ

プロジェクトのセットアップが必要かどうかは shouldSetupProject を参照
プロジェクトのセットアップを開始するには setupProject を参照
翻訳ジョブを開始するには enqueueFiles を参照
ファイル単位の情報については querySourceFile を参照

概要

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const projectData = await gt.getProjectData('project-123');
console.log(`プロジェクト: ${projectData.name}`);
console.log(`既定のロケール: ${projectData.defaultLocale}`);
console.log(`対象ロケール: ${projectData.currentLocales.join(', ')}`);

リファレンス

パラメーター

名称	型	説明
`projectId`	`string`	取得対象のプロジェクトを特定する一意の識別子
`options?`	`{ timeout?: number }`	リクエストのためのオプション設定

オプション

名称	型	説明
`timeout?`	`number`	リクエストのタイムアウト（ミリ秒）

戻り値

Promise<ProjectData> - プロジェクトの情報と構成を含みます。

type ProjectData = {
  id: string;
  名称: string;
  orgId: string;
  既定のロケール: string;
  対応ロケール: string[];
}

プロパティ	型	説明
`id`	`string`	プロジェクトの一意な識別子
`name`	`string`	人間が判読しやすいプロジェクトの名称
`orgId`	`string`	当該プロジェクトを所有する組織の識別子
`defaultLocale`	`string`	プロジェクトの既定のソースロケール
`currentLocales`	`string[]`	現在構成されている対象ロケールの配列

例

基本的な使い方

index.ts

import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key'
});

async function getProjectInfo(projectId: string) {
  try {
    const project = await gt.getProjectData(projectId);
    
    console.log('=== プロジェクト情報 ===');
    console.log(`ID: ${project.id}`);
    console.log(`名称: ${project.name}`);
    console.log(`組織: ${project.orgId}`);
    console.log(`既定のロケール: ${project.defaultLocale}`);
    console.log(`対象ロケール: ${project.currentLocales.join(', ')}`);
    
    return project;
  } catch (error) {
    console.error(`プロジェクト ${projectId} の取得に失敗しました:`, error);
    throw error;
  }
}

const projectInfo = await getProjectInfo('my-project-123');

注意事項

このメソッドはプロジェクト情報への読み取り専用アクセスを提供します。プロジェクト設定の変更はdashboardで行ってください
このメソッドの利用には有効なプロジェクトIDが必要です。提供されたAPIキーで当該プロジェクトにアクセスできる必要があります
プロジェクトデータには、ソースおよびターゲットの両方のlocale設定が含まれます
currentLocales 配列は、そのプロジェクトで設定されているすべてのターゲットlocaleを表します
翻訳ワークフローを開始する前に、プロジェクト設定の妥当性確認にこのメソッドを使用してください

次のステップ

プロジェクトのセットアップが必要かどうかは shouldSetupProject を参照
プロジェクトのセットアップを開始するには setupProject を参照
翻訳ジョブを開始するには enqueueFiles を参照
ファイル単位の情報については querySourceFile を参照

getProjectData

概要

リファレンス

パラメーター

オプション

戻り値

例

基本的な使い方

注意事項

次のステップ

このページについて

getProjectData

概要

リファレンス

パラメーター

オプション

戻り値

例

基本的な使い方

注意事項

次のステップ

このページについて

getProjectData

概要

リファレンス

パラメーター

オプション

戻り値

例

基本的な使い方

注意事項

次のステップ

このページについて

GitHub でスターする

GitHub でスターする

getProjectData

このページについて

getProjectData

このページについて

getProjectData

このページについて

GitHubGitHub でスターする

GitHubGitHub でスターする

GitHub でスターする

GitHub でスターする