GS2-Schedule

Create Client

schedule_client = client('schedule')

Method

create_event_master

response = schedule_client:create_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターを新規作成します

Request

{
  scheduleName=string,
  name=string,
  meta=string,
  type=string,
  absoluteBegin=number,
  absoluteEnd=number,
  relativeTriggerName=string,
  relativeSpan=number,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• name

• [string] イベントマスター名

• meta

• [string] メタデータ

• type

• [string] 期間

• absoluteBegin

• [number] 絶対時間を選択した場合の開始日時

• absoluteEnd

• [number] 絶対時間を選択した場合の終了日時

• relativeTriggerName

• [string] 相対時間を選択した場合の開始トリガー名

• relativeSpan

• [number] 相対時間を選択した場合のトリガーを引いてからのイベント期間(分)

Response

• item

• [EventMaster] イベントマスター

create_schedule

response = schedule_client:create_schedule(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スケジュールを新規作成します

Request

{
  name=string,
  description=string,
}

• name

• [string] スケジュール名

• description

• [string] 説明文

Response

• item

• [Schedule] スケジュール

delete_event_master

response = schedule_client:delete_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターを削除します

Request

{
  scheduleName=string,
  eventName=string,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• eventName

• [string] イベント名を指定します。

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

None

delete_schedule

response = schedule_client:delete_schedule(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スケジュールを削除します

Request

{
  scheduleName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

Response

None

delete_trigger

response = schedule_client:delete_trigger(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

トリガーを削除します

Request

{
  scheduleName=string,
  userId=string,
  triggerName=string,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• userId

• [string] ユーザIDを指定します。

• triggerName

• [string] トリガー名を指定します。

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

None

describe_event

response = schedule_client:describe_event(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

開催中のイベントの一覧を取得します

Request

{
  scheduleName=string,
  eventNames=string,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• eventNames

• [string] 取得するイベント名をカンマ区切りのリストで指定する

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

• items

• [table<Event>] イベント

describe_event_by_user_id

response = schedule_client:describe_event_by_user_id(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

開催中のイベントの一覧を取得します

Request

{
  scheduleName=string,
  userId=string,
  eventNames=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• userId

• [string] ユーザIDを指定します。

• eventNames

• [string] 取得するイベント名をカンマ区切りのリストで指定する

Response

• items

• [table<Event>] イベント

describe_event_master

response = schedule_client:describe_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターの一覧を取得します

Request

{
  scheduleName=string,
  pageToken=string,
  limit=number,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• pageToken

• [string] データの取得を開始する位置を指定するトークン

• limit

• [number] データの取得件数

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

• items

• [table<EventMaster>] イベントマスター

• nextPageToken

• [string] 次のページを読み込むためのトークン

describe_schedule

response = schedule_client:describe_schedule(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スケジュールの一覧を取得します

Request

{
  pageToken=string,
  limit=number,
}

• pageToken

• [string] データの取得を開始する位置を指定するトークン

• limit

• [number] データの取得件数

Response

• items

• [table<Schedule>] スケジュール

• nextPageToken

• [string] 次のページを読み込むためのトークン

describe_trigger

response = schedule_client:describe_trigger(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

トリガーの一覧を取得します

Request

{
  scheduleName=string,
  pageToken=string,
  limit=number,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• pageToken

• [string] データの取得を開始する位置を指定するトークン

• limit

• [number] データの取得件数

Response

• items

• [table<Trigger>] トリガー

• nextPageToken

• [string] 次のページを読み込むためのトークン

describe_trigger_by_user_id

response = schedule_client:describe_trigger_by_user_id(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ユーザのトリガーの一覧を取得します

Request

{
  scheduleName=string,
  userId=string,
  pageToken=string,
  limit=number,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• userId

• [string] ユーザIDを指定します。

• pageToken

• [string] データの取得を開始する位置を指定するトークン

• limit

• [number] データの取得件数

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

• items

• [table<Trigger>] トリガー

• nextPageToken

• [string] 次のページを読み込むためのトークン

export_master

response = schedule_client:export_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターをエクスポートします

Request

{
  scheduleName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

Response

• item

• [string] エクスポートされたイベントマスターデータ

get_current_event_master

response = schedule_client:get_current_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

現在適用されているイベントマスターを取得します

Request

{
  scheduleName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

Response

• item

• [string] 現在適用されているイベントマスターデータ

get_event

response = schedule_client:get_event(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

開催中のイベントを取得します

Request

{
  scheduleName=string,
  eventName=string,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• eventName

• [string] イベント名を指定します。

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

• item

• [Event] イベント

get_event_by_user_id

response = schedule_client:get_event_by_user_id(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

開催中のイベントを取得します

Request

{
  scheduleName=string,
  userId=string,
  eventName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• userId

• [string] ユーザIDを指定します。

• eventName

• [string] イベント名を指定します。

Response

• item

• [Event] イベント

get_event_master

response = schedule_client:get_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターを取得します

Request

{
  scheduleName=string,
  eventName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• eventName

• [string] イベント名を指定します。

Response

• item

• [EventMaster] イベントマスター

get_schedule

response = schedule_client:get_schedule(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スケジュールを取得します

Request

{
  scheduleName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

Response

• item

• [Schedule] スケジュール

get_schedule_status

response = schedule_client:get_schedule_status(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スケジュールの状態を取得します

Request

{
  scheduleName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

Response

• status

• [string] ステータス

get_trigger

response = schedule_client:get_trigger(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

トリガーを取得します

Request

{
  scheduleName=string,
  userId=string,
  triggerName=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• userId

• [string] ユーザIDを指定します。

• triggerName

• [string] トリガー名を指定します。

Response

• item

• [Trigger] トリガー

pull_trigger

response = schedule_client:pull_trigger(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

トリガーを引きます

Request

{
  scheduleName=string,
  userId=string,
  triggerName=string,
  action=string,
  ttl=number,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• userId

• [string] ユーザIDを指定します。

• triggerName

• [string] トリガーの名前を指定します。

• action

• [string] 既にトリガーが引かれていた時の振る舞い

• ttl

• [number] action に if_expired_pull_again を指定したときに使用するトリガーの有効期間(分)

Response

• item

• [Trigger] トリガー

update_current_event_master

response = schedule_client:update_current_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターを更新します

Request

{
  scheduleName=string,
  settings=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• settings

• [string] イベントマスターデータ

Response

• item

• [string] 更新したイベントマスターデータ

update_event_master

response = schedule_client:update_event_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

イベントマスターを更新します

Request

{
  scheduleName=string,
  eventName=string,
  meta=string,
  type=string,
  absoluteBegin=number,
  absoluteEnd=number,
  relativeTriggerName=string,
  relativeSpan=number,
  accessToken=string
}

• scheduleName

• [string] スケジュールの名前を指定します。

• eventName

• [string] イベント名を指定します。

• meta

• [string] メタデータ

• type

• [string] 期間

• absoluteBegin

• [number] 絶対時間を選択した場合の開始日時

• absoluteEnd

• [number] 絶対時間を選択した場合の終了日時

• relativeTriggerName

• [string] 相対時間を選択した場合の開始トリガー名

• relativeSpan

• [number] 相対時間を選択した場合のトリガーを引いてからのイベント期間(分)

• accessToken

• [string] GS2-Auth で発行を受けたアクセストークン

Response

• item

• [EventMaster] イベントマスター

update_schedule

response = schedule_client:update_schedule(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スケジュールを更新します

Request

{
  scheduleName=string,
  description=string,
}

• scheduleName

• [string] スケジュールの名前を指定します。

• description

• [string] 説明文

Response

• item

• [Schedule] スケジュール

Model

Schedule

• scheduleId

• [string] スケジュールGRN

• ownerId

• [string] オーナーID

• name

• [string] スケジュール名

• description

• [string] 説明文

• createAt

• [number] 作成日時(エポック秒)

• updateAt

• [number] 最終更新日時(エポック秒)

EventMaster

• eventMasterId

• [string] イベントマスターGRN

• name

• [string] イベントマスター名

• meta

• [string] メタデータ

• type

• [string] 期間

• absoluteBegin

• [number] 絶対時間を選択した場合の開始日時

• absoluteEnd

• [number] 絶対時間を選択した場合の終了日時

• relativeTriggerName

• [string] 相対時間を選択した場合の開始トリガー名

• relativeSpan

• [number] 相対時間を選択した場合のトリガーを引いてからのイベント期間(分)

• createAt

• [number] 作成日時(エポック秒)

• updateAt

• [number] 最終更新日時(エポック秒)

Trigger

• userId

• [string] ユーザID

• triggerName

• [string] トリガーID

• triggerAt

• [number] トリガーを引いた時間(エポック秒)

Event

• name

• [string] イベント名

• meta

• [string] メタデータ

• begin

• [number] 開始日時

• end

• [number] 終了日時