はじめに
GASでAsanaAPIを使ってカスタムフィールドありのタスクを作成する際、
調べてもよく分からず暗中模索して困ったため、その答えを紹介します。
gidで指定する必要がある
Asanaの基本的な概念として「gid」というものがあります。
Asanaの内部IDだと認識しておけばOKです。
プロジェクトgidやユーザgidなどが存在します。
そして、カスタムフィールド1つ1つにもgidが存在します。
タスク作成時にカスタムフィールドに値を入力する場合、gidでの指定が必要です。
更にプロジェクト上でカスタムフィールドの選択肢を作成している場合、
その各選択肢にもgidが存在します。
タスク作成、APIでカスタムフィールドを操作する際は、
下記コード例のようにgidを用いて指示します。
function createTask() {
const headers = {
"Authorization": "Bearer " + "token"
};
const payload = JSON.stringify({
"data": {
"workspace" : "workspaceId", // ワークスペースID
"projects" : ["projectId"], // プロジェクトID
"name" : "title", // タスクタイトル
"assignee" : "assignee@mail.jp", // タスク担当者アドレス
"followers" : ["collab1@mail.jp", "collab2@mail.jp"], // コラボレーターアドレス
"html_notes" : body, // タスク本文html
"due_on" : "2024-03-30", // タスク期日
"custom_fields":{1234567890:"1111111111", // カスタムフィールドgid:選択肢gid
2345678901:"2222222222", // カスタムフィールドgid:選択肢gid
3456789012:"text", // カスタムフィールドgid:入力値テキスト
4567890123:"int"} // カスタムフィールドgid:入力値数値
}
});
const options = {
"method" : "post",
"contentType" : "application/json",
"headers" : headers,
"payload" : payload,
"muteHttpExceptions" : true
};
const response = UrlFetchApp.fetch("https://app.asana.com/api/1.0/tasks", options);
if(JSON.parse(response.getContentText()).errors){
throw new Error(`error:${response.getContentText()}`);
}
else{
const responseJson = JSON.parse(response);
const task_id = responseJson.data.gid;
const taskUrl = `https://app.asana.com/0/プロジェクトID/${task_id}`;
return taskUrl;
}
}
サンプルコードではカスタムフィールド以外にも任意の属性を指定しています。
このコードを使用する場合は、必要に応じて置換してください。
カスタムフィールドのところを見てみると、
gidに対して選択肢のgidや、入力値を直接指定しているのが分かると思います。
選択式フィールドの場合はgidを、入力式フィールドの場合は直指定となります。
カスタムフィールドgidを取得するには
さて、このカスタムフィールドのgidですが、
現在Asanaのweb画面上から取得する方法はありません。
カスタムフィールドのgidを取得するには、
APIのGet a project’s custom fieldsやGet a projectを使う必要があります。
前者の方がシンプルに情報取得できるため前者を例示しますが、
カスタムフィールド以外のプロジェクト情報も必要な場合は後者を使うと良いでしょう。
function getProjectCustomField(projectId){
const baseUrl = `https://app.asana.com/api/1.0/projects/${projectId}/custom_field_settings?limit=100`;
const options = {
"method" : "GET",
"headers" : {"Authorization": "Bearer " + token,
"accept": "application/json"
},
"muteHttpExceptions" : true
};
let nextPage = null;
let result = [];
// ページループ
do{
const url = `${baseUrl}${nextPage ? `&offset=${nextPage.offset}` : ""}`;
const singleResponse = UrlFetchApp.fetch(url, options);
const jsonResult = JSON.parse(singleResponse);
result = result.concat(jsonResult.data);
nextPage = jsonResult.next_page;
}
while(nextPage)
return result;
}
以下のような戻り値となります。
custom_field属性直下のgidがフィールドgidです、
typeがenumの場合、選択式フィールドである事を表しています。
選択肢はenum_optionsに格納されており、その中のgidが各選択肢のgidとなります。
{
"data": [
{
"gid": "12345",
"resource_type": "task",
"project": {
"gid": "12345",
"resource_type": "task",
"name": "Stuff to buy"
},
"is_important": false,
"parent": {
"gid": "12345",
"resource_type": "task",
"name": "Stuff to buy"
},
"custom_field": {
"gid": "12345",
"resource_type": "task",
"name": "Status",
"resource_subtype": "text",
"type": "text",
"enum_options": [
{
"gid": "12345",
"resource_type": "task",
"name": "Low",
"enabled": true,
"color": "blue"
}
],
"enabled": true,
"representation_type": "number",
"id_prefix": "ID",
"is_formula_field": false,
"date_value": {
"date": "2024-08-23",
"date_time": "2024-08-23T22:00:00.000Z"
},
"enum_value": {
"gid": "12345",
"resource_type": "task",
"name": "Low",
"enabled": true,
"color": "blue"
},
"multi_enum_values": [
{
"gid": "12345",
"resource_type": "task",
"name": "Low",
"enabled": true,
"color": "blue"
}
],
"number_value": 5.2,
"text_value": "Some Value",
"display_value": "blue",
"description": "Development team priority",
"precision": 2,
"format": "custom",
"currency_code": "EUR",
"custom_label": "gold pieces",
"custom_label_position": "suffix",
"is_global_to_workspace": true,
"has_notifications_enabled": true,
"asana_created_field": "priority",
"is_value_read_only": false,
"created_by": {
"gid": "12345",
"resource_type": "task",
"name": "Greg Sanchez"
},
"people_value": [
{
"gid": "12345",
"resource_type": "task",
"name": "Greg Sanchez"
}
]
}
}
],
"next_page": {
"offset": "eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
"path": "/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9",
"uri": "https://app.asana.com/api/1.0/tasks/12345/attachments?limit=2&offset=eyJ0eXAiOJiKV1iQLCJhbGciOiJIUzI1NiJ9"
}
}
さいごに
AsanaAPIにおけるカスタムフィールドへの理解は深まりましたでしょうか。
もし必要があればAsanaに関する他の記事も参照してお役立てください。
Asana APIトークンや各種IDを取得する基本的な方法を解説
