Jobs methods¶
ここでは、案件をGengo API上で扱うエンドポイントをご説明しています。
Jobs (POST)¶
- 概要 :
翻訳する案件またはグループ案件を提出してください。1件のご注文内ですべての案件が同じ言語ペアとレベルである場合は、案件がグループ化されます。
- URL :
http://api.gengo.com/v2/translate/jobs
- 認証 :
必須
- パラメータ :
api_key
(必須) - お客様の API keyapi_sig
(必須) - お客様の API signaturets
(必須) - 現在のUNIX時間のInteger (整数型)
- データ引数 :
jobs
(必須) - 案件のペイロードの配列の1つ。案件ペイロードの必須項目についてはパラメータ一覧ページを参照ください。
呼び出し例
1#!/usr/bin/python
2# -*- coding: utf-8 -*-
3
4from gengo import Gengo
5
6
7gengo = Gengo(
8 public_key='your_public_key',
9 private_key='your_private_key',
10 sandbox=False,
11 debug=False)
12
13data = {
14 'jobs': {
15 'job_1': {
16 'type': 'text',
17 'slug': 'Single :: English to Japanese',
18 'body_src': 'Testing Gengo API library calls.',
19 'lc_src': 'en',
20 'lc_tgt': 'ja',
21 'tier': 'standard',
22 'auto_approve': 0,
23 'comment': 'Instructions for translators on this specific job go here',
24 'attachments': [{'url': 'http://example.com/image01.jpg', 'filename': 'image01.jpg', 'mime_type': 'image/jpg'},
25 {'url': 'http://example.com/video/1234', 'filename': 'video.mp4', 'mime_type': 'video/mp4'}],
26 'callback_url': 'http://...',
27 'custom_data': 'your optional custom data, limited to 1kb.',
28 'force': 0,
29 'use_preferred': 0,
30 },
31 'job_2': {
32 'type': 'text',
33 'slug': 'Single :: English to Japanese',
34 'body_src': 'Testing Gengo API library calls.',
35 'lc_src': 'en',
36 'lc_tgt': 'ja',
37 'tier': 'standard',
38 'auto_approve': 0,
39 'comment': 'Instructions for translators on this specific job go here',
40 'attachments': [{'url': 'http://example.com/image02.jpg', 'filename': 'image02.jpg', 'mime_type': 'image/jpg'},
41 {'url': 'http://example.com/video/4321', 'filename': 'video01.mp4', 'mime_type': 'video/mp4'}],
42 'callback_url': 'http://...',
43 'custom_data':'your optional custom data, limited to 1kb.',
44 'force': 0,
45 'use_preferred': 0,
46 'services': ['translation', 'edit'],
47 },
48 },
49 'comment':'Instructions for translators on the entire order go here'
50}
51
52print(gengo.postTranslationJobs(jobs=data))
Comments
コメントの提出は、個々の案件またはご注文全体を対象に行うことができます。
返り値
どんなケースでも、レスポンスはほぼ瞬時に返って来るはずです。それを踏まえて申し上げると、POSTの呼び出しで送信された案件により、3種類のレスポンスのペイロードがあり得ます。
すべての案件が既存でない場合
新規案件だけの場合か、全ての案件にforceのフラグが付いている場合は、レスポンスには新しいご注文ID、案件数、ご注文価格 が含まれます。
1{
2 "opstat": "ok",
3 "response": {
4 "job_count": 10,
5 "order_id": 139370,
6 "credits_used": 100.45,
7 "currency": "USD"
8 }
9}
すべての案件が既存の案件と同じ場合
100%マッチする案件だけの場合 (つまり、全ての案件はご注文済みで、翻訳が存在する場合)、レスポンスはその案件のリスト (オリジナルの提出時と同内容) になります。こうした案件のステータスは、"approved" に変更されていくはずです。各インデックスはリストである点にご注目ください。これは、以前のPOSTでforceのフラグが使われている場合、1つのペイロードに対してマッチする案件が数件が存在する可能性があるからです。
翻訳は "body_tgt" として保存されます。order idは新しい値で、credits_usedは同じ価格になりますが再課金はされません。というのは、私たちは新規コンテンツを一切注文していないからです。
1 "opstat": "ok",
2 "response": {
3 "jobs": {
4 "job_2": [
5 {
6 "custom_data": "1234567",
7 "job_id": 1821444,
8 "credits": 0.10,
9 "auto_approve": 0,
10 "eta": -1,
11 "lc_tgt": "fr",
12 "unit_count": 1,
13 "lc_src": "en",
14 "slug": "3",
15 "callback_url": "http://example.com",
16 "currency": "USD",
17 "tier": "pro",
18 "body_src": "Third",
19 "body_tgt": "Troisieme",
20 "ctime": 1378703629,
21 "status": "reviewable"
22 }
23 ],
24 "job_1": [
25 {
26 "custom_data": "1234567",
27 "job_id": 1821443,
28 "credits": 0.10,
29 "auto_approve": 0,
30 "eta": -1,
31 "lc_tgt": "fr",
32 "unit_count": 1,
33 "lc_src": "en",
34 "slug": "3",
35 "callback_url": "http://example.com",
36 "currency": "USD",
37 "tier": "pro",
38 "body_src": "Second",
39 "body_tgt": "Deuxieme",
40 "ctime": 1378703629,
41 "status": "reviewable"
42 }
43 ]
44 },
45 "job_count": 2,
46 "order_id": 754511,
47 "credits_used": 0.00,
48 "currency": "USD"
49 }
50}
同一案件が案件のペイロード中に存在する場合
ご発注いただいたペイロード中に同一の案件が存在する場合、その案件に関するレスポンスでは以前の案件でお届けしたものと同一の訳文テキストを返します
job countは送付された案件数になりますが、ポイントはペイロード中に含まれた繰り返し案件の1件分だけに課金されます。各リクエストに新しいorder idが作成されます。
1 "opstat": "ok",
2 "response": {
3 "jobs": [
4 [
5 {
6 "job_id": 1087795,
7 "credits": 0.10,
8 "auto_approve": 0,
9 "eta": 25308,
10 "lc_tgt": "fr",
11 "unit_count": 2,
12 "lc_src": "en",
13 "slug": "API Job test",
14 "callback_url": "http://example.com",
15 "currency": "USD",
16 "tier": "standard",
17 "body_src": "First test.",
18 "body_tgt": "Premier test.",
19 "ctime": 1378694499,
20 "status": "available"
21 }
22 ],
23 [
24 {
25 "job_id": 1087795,
26 "credits": 0.10,
27 "auto_approve": 0,
28 "eta": 25308,
29 "lc_tgt": "fr",
30 "unit_count": 2,
31 "lc_src": "en",
32 "slug": "API Job test",
33 "callback_url": "http://example.com",
34 "currency": "USD",
35 "tier": "standard",
36 "body_src": "First test.",
37 "body_tgt": "Premier test.",
38 "ctime": 1378694499,
39 "status": "available"
40 }
41 ]
42 ],
43 "job_count": 2,
44 "order_id": 122900,
45 "credits_used": 0.10,
46 "currency": "USD"
47 }
48}
49
50// Mix of new and old jobs
51{
既存の案件と新規案件が混在する場合
以前にご注文された案件 (コンテンツと言語ペア部分が100%マッチする案件) と新規案件がPOSTに混在する場合、過去の案件、新規案件のご注文ID、ご注文に含まれる新規案件の合計価格が含まれたレスポンスが返されます。
job_countの数は、あなたのペイロードの中で送付された総案件数で、新規の案件数だけではありませんのでご注意ください。
1 "jobs": {
2 "old_job1": [
3 {
4 "custom_data": "1234567",
5 "job_id": 1821444,
6 "credits": 0.10,
7 "auto_approve": 0,
8 "eta": -1,
9 "lc_tgt": "fr",
10 "unit_count": 1,
11 "lc_src": "en",
12 "slug": "3",
13 "callback_url": "http://example.com",
14 "currency": "USD",
15 "tier": "pro",
16 "body_src": "Third",
17 "body_tgt": "Troisieme",
18 "ctime": 1378703629,
19 "status": "reviewable"
20 }
21 ]
22 },
23 "job_count": 2,
24 "order_id": 754513,
25 "credits_used": 0.20,
26 "currency": "USD"
27 }
28}
Jobs (GET)¶
- 概要 :
指定パラメータでフィルターされた直近案件での使用リソースのリストを取得します。
- URL :
http://api.gengo.com/v2/translate/jobs
- 認証 :
必須
- パラメータ :
api_key
(必須) - お客様の API keyapi_sig
(必須) - お客様の API signaturets
(必須) - 現在のUNIX時間のInteger (整数型)
- データ引数 :
status
(任意) - 案件の現在のステータス。「新着案件」、「保留中」、「レビュー可」、「修正中」、「承認済み」、または「キャンセル済み」。timestamp_after
(任意) - 案件を送信した時間からのエポックタイムcount
(任意) - デフォルト10件 (最大 200件)
- Note
countだけを使った場合、直近からcountで指定された件数が返されます
countをtimestamp_afterと共に使った場合、timestamp_after以降に送信された、countで指定された件数が返されます
timestamp_afterだけを使った場合、timestamp_after以降に送信された全案件数が返されます
呼び出し例
1#!/usr/bin/python
2# -*- coding: utf-8 -*-
3
4from gengo import Gengo
5
6
7gengo = Gengo(
8 public_key='your_public_key',
9 private_key='your_private_key',
10 sandbox=False,
11 debug=False)
12
13print(gengo.getTranslationJobs(status="available", count=15))
返り値
1{
2 "opstat": "ok",
3 "response": [
4 {
5 "job_id": 123,
6 "ctime": "..."
7 },
8 {
9 "job_id": 425,
10 "ctime": "..."
11 },
12 {
13 "job_id": 274,
14 "ctime": "..."
15 }
16 ]
17}
Jobs by id (GET)¶
- 概要 :
案件のリストを取得します。これらは、案件IDをカンマで区切ったリストを使ってリクエストできます。
- URL :
http://api.gengo.com/v2/translate/jobs/{ids}
- 認証 :
必須
- パラメータ :
api_key
(必須) - お客様の API keyapi_sig
(必須) - お客様の API signaturets
(必須) - 現在のUNIX時間のInteger (整数型)
- Note
案件がファイルの場合、レスポンスに``file_url_src``と``file_url_tgt``が含まれます。
呼び出し例
1#!/usr/bin/python
2# -*- coding: utf-8 -*-
3
4from gengo import Gengo
5
6
7gengo = Gengo(
8 public_key='your_public_key',
9 private_key='your_private_key',
10 sandbox=False,
11 debug=False)
12
13print(gengo.getTranslationJobBatch(id="1,2"))
返り値
1{
2 "opstat": "ok",
3 "response": {
4 "jobs": [
5 {
6 "custom_data": "{internal_id: 2311}",
7 "job_id": 1,
8 "credits": 0.25,
9 "auto_approve": 1,
10 "eta": 25308,
11 "order_id": 54632,
12 "lc_tgt": "jp",
13 "unit_count": 5,
14 "lc_src": "en",
15 "slug": "This is a short story",
16 "callback_url": "http://yourapp.com/gengo_callback/job/1",
17 "currency": "USD",
18 "tier": "standard",
19 "body_src": "This is a short story",
20 "ctime": 1352879655,
21 "status": "available"
22 },
23 {
24 "custom_data": "{internal_id: 2312}",
25 "job_id": 2,
26 "credits": 0.35,
27 "auto_approve": 1,
28 "eta": 25308,
29 "order_id": 54632,
30 "lc_tgt": "jp",
31 "unit_count": 7,
32 "lc_src": "en",
33 "slug": "This is a short story as well",
34 "callback_url": "http://yourapp.com/gengo_callback/job/2",
35 "currency": "USD",
36 "tier": "standard",
37 "body_src": "This is a short story as well",
38 "ctime": 1352879764,
39 "status": "available"
40 }
41 ]
42 }
43}
Jobs (PUT)¶
- 概要 :
翻訳対象の案件を更新します。リクエストは100MB以下に収める必要があります。コメントは25,000文字以下で入力してください。
- URL :
http://api.gengo.com/v2/translate/jobs/
- 認証 :
必須
- パラメータ :
api_key
(必須) - お客様の API keyapi_sig
(必須) - お客様の API signaturets
(必須) - 現在のUNIX時間のInteger (整数型)
- データ引数 :
- action (必須) : (案件毎)
- "revise" - 案件を翻訳者に戻して修正を依頼します。
その他のパラメータ
comment
(必須) - 翻訳者に案件を戻して修正を求める理由。
- "approve" - 案件を承認します。
その他のパラメータ
rating
(任意) 評価に関するガイドラインを含む ― 1(悪い)から5(非常に良い)までfor_translator
(任意) 翻訳者へのコメントfor_mygengo
(任意) Gengoスタッフへのコメント (非公開)public
(任意) 1 (true) か 0 (false - デフォルト)。このフィードバックをGengoが公開してよいか
- "reject" - 翻訳を拒否します。案件拒否プロセスの詳細については、弊社のFAQをご覧ください。
その他のパラメータ
reason
(必須) - "quality", "incomplete", "other"comment
(必須)follow_up
(任意) "requeue" (デフォルト) か "cancel" のいずれかになります。"requeue" を選択した場合、案件は拒否され、別の翻訳者に再依頼されます。"cancel" を選択した場合、案件は拒否した時点で完全にキャンセルとなります。
"“archive“" - 案件をアーカイブします。
呼び出し例
1#!/usr/bin/python
2# -*- coding: utf-8 -*-
3
4from gengo import Gengo
5
6
7gengo = Gengo(
8 public_key='your_public_key',
9 private_key='your_private_key',
10 sandbox=False,
11 debug=False)
12
13# Archive a group of jobs
14gengo.updateTranslationJobs(action={
15 'job_ids': [4854, 547],
16 'action': 'archive'
17})
18
19# Revise a group of jobs
20gengo.updateTranslationJobs(action={
21 'action': 'revise',
22 'job_ids': [{'job_id': 922, 'comment': 'Please change the word banana to gorilla'},
23 {'job_id': 923, 'comment': 'Please change the word banana to monkey'}],
24})
25
26## Reject a group of jobs
27gengo.updateTranslationJobs(action={
28 'action': 'reject',
29 'job_ids': [{'job_id': 929, 'reason': 'quality', 'comment': 'This sentence should be in the past tense'},
30 {'job_id': 811, 'reason': 'quality', 'comment': 'This should have be capitalized'}],
31})
32
33# Approve a group of jobs
34gengo.updateTranslationJobs(action={
35 'action': 'approve',
36 'job_ids': [{'job_id': 924},
37 {'job_id': 928}],
38})
返り値
1// Archive a group of jobs
2{
3 "opstat": "ok",
4 "response": {
5
6 }
7}
8
9// Revising a group of jobs.
10{
11 "opstat": "ok",
12 "response": {
13
14 }
15}
16
17// Rejecting a group of jobs.
18{
19 "opstat": "ok",
20 "response": {
21 "jobs": [
22 {
23 "rejection_comments": "...",
24 "worker_id": 4,
25 "rejection_reason": "quality",
26 "customer_id": 3,
27 "job_id": 929
28 },
29 {
30 "rejection_comments": "...",
31 "worker_id": 4,
32 "rejection_reason": "quality",
33 "customer_id": 3,
34 "job_id": 811
35 }
36 ]
37 }
38}
39
40// Approving a group of jobs.
41{
42 "opstat": "ok",
43 "response": {
44
45 }
46}