CLI を使い始める

research prtimes

orc research prtimes は、PR TIMESのリリースを検索し、分類や企業から一覧をたどって本文・反応・公開素材を取得するコマンドです。map で分類の入口を確認し、検索結果の企業IDとリリースIDから詳細へ進みます。

認証済みのCLIと、アクセス可能なWorkspaceが必要です。--workspace で今回の対象を指定できます。

使い方

terminal
orc research prtimes search --q "生成AI" --workspace <workspace-id> --json

公開リリースを検索する。

サブコマンド

business-categories releases list

指定した事業カテゴリのIDでリリースを一覧表示します。IDは map から確認してください。

terminal
orc research prtimes business-categories releases list <id> [options]

固有のオプション

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

型: number。任意。

terminal
orc research prtimes business-categories releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes business-categories releases list <id> --include-native <value>
--subcategory-id

Child category id from the selected business category in map.business_categories. Omit it to request the parent category.

型: string。任意。

terminal
orc research prtimes business-categories releases list <id> --subcategory-id <value>

channels releases list

指定したチャネルのIDでリリースを一覧表示します。IDは map から確認してください。

terminal
orc research prtimes channels releases list <id> [options]

固有のオプション

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

型: number。任意。

terminal
orc research prtimes channels releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes channels releases list <id> --include-native <value>

companies get

企業IDを指定して公開プロフィールを取得します。企業名やURLではなく一覧にあるIDを使います。

terminal
orc research prtimes companies get <company-id> [options]

companies releases list

指定企業が公開したリリースを一覧表示します。取得した企業IDをそのまま使い、継続時も対象企業を維持します。

terminal
orc research prtimes companies releases list <company-id> [options]

固有のオプション

--offset

Number of company releases to skip. The upstream page size is fixed at 10. Use pagination.next_url instead of assuming the next offset.; (use "null" or "reset" to clear)

型: number。任意。

terminal
orc research prtimes companies releases list <company-id> --offset <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes companies releases list <company-id> --include-native <value>

companies releases get

企業IDとリリースIDを指定し、本文、反応、分類、画像・添付資料へのリンクを取得します。検索一覧から個別の内容を比較するときに使います。

terminal
orc research prtimes companies releases get <company-id> <release-id> [options]

company-categories releases list

指定した企業カテゴリのIDでリリースを一覧表示します。IDは map から確認してください。

terminal
orc research prtimes company-categories releases list <id> [options]

固有のオプション

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

型: number。任意。

terminal
orc research prtimes company-categories releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes company-categories releases list <id> --include-native <value>

keywords list

PR TIMESの人気キーワードを取得し、リリース検索の候補を探します。件数を検索需要の指標として扱わないでください。

terminal
orc research prtimes keywords list [options]

map

分類とリリース一覧の入口を取得します。分類別の一覧には、このレスポンスで確認したIDを使います。

terminal
orc research prtimes map [options]

prefectures releases list

指定した都道府県のIDでリリースを一覧表示します。IDは map から確認してください。

terminal
orc research prtimes prefectures releases list <id> [options]

固有のオプション

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

型: number。任意。

terminal
orc research prtimes prefectures releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes prefectures releases list <id> --include-native <value>
--location-type

Location relationship from map.location_types, such as headquarters or event venue. Applies only to prefecture collections. Omit it for no additional location-type filter.; (use "null" or "reset" to clear)

型: number。任意。

terminal
orc research prtimes prefectures releases list <id> --location-type <value>

rankings list

--type で選んだランキングの現在の掲載順と順位を取得します。期間や更新タイミングはPR TIMESが決めるため、過去の人気を保証する一覧ではありません。

terminal
orc research prtimes rankings list [options]

固有のオプション

--type

Native PR TIMES ranking selector. PR TIMES controls each time window and ordering; names do not imply a fixed duration guaranteed by Orchestor.; enum: hot|now|daily|weekly|monthly

型: string。任意。

terminal
orc research prtimes rankings list --type <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes rankings list --include-native <value>

release-types releases list

指定したリリース種別のIDでリリースを一覧表示します。IDは map から確認してください。

terminal
orc research prtimes release-types releases list <id> [options]

固有のオプション

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

型: number。任意。

terminal
orc research prtimes release-types releases list <id> --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes release-types releases list <id> --include-native <value>

releases list

新しく公開されたリリースを原典の掲載順で取得します。詳細を調べる場合は返された企業IDとリリースIDを使います。

terminal
orc research prtimes releases list [options]

固有のオプション

--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes releases list --include-native <value>

--q のキーワードをPR TIMESの検索へ渡し、該当するリリースを取得します。検索結果から企業IDとリリースIDを取得して詳細へ進みます。

terminal
orc research prtimes search [options]

固有のオプション

--page

One-based source page number. Prefer pagination.next_url for subsequent requests so filters are preserved.

型: number。任意。

terminal
orc research prtimes search --page <value>
--include-native

Set true to include original source fields in each list item. false returns the smaller normalized summary. This query parameter is the literal string true or false.; enum: true|false

型: string。任意。

terminal
orc research prtimes search --include-native <value>
--q

Keyword or phrase passed to native PR TIMES search. Leading and trailing whitespace is removed. URL-encode the value.; max 200 chars

型: string。必須。

terminal
orc research prtimes search --q <value>

使用例

現在の週次ランキングを取得する。

terminal
orc research prtimes rankings list --type weekly --workspace <workspace-id> --json

現在の週次ランキングを取得する。

検索結果からリリースの詳細を取得する。

terminal
orc research prtimes companies releases get <company-id> <release-id> --workspace <workspace-id> --json

検索結果からリリースの詳細を取得する。

出力とページ送り

一覧は一回の呼び出しで一ページを取得します。返された pagination.next_url のクエリ値を、対応するフラグへ渡して続きを取得してください。検索条件は維持します。継続情報が不明でも全件取得済みとは判断せず、--page-all による自動巡回は行いません。

--json ではAPIレスポンス全体をCLIの data に保持します。取得内容は data.data、継続情報は data.pagination、取得元情報は data.source です。--raw はCLIの外枠を外し、--field data はAPIのデータだけを選択します。欠損値やnullを0として扱わないでください。

反応・分類・素材の取得

検索一覧は発見用です。反応や素材を比較するときは各行の company.id と release_id を companies releases get に渡してください。追加フラグは不要です。

記事詳細は本文・キーワードに加え、engagement.like_count とその source.observed_at、release_type、keyword_links、リンク付き business_categories、URL付き images、reference_url、materials_url、公開添付資料の attachments、share_links を返します。素材ページや添付先を返すだけで、ファイルのダウンロードや利用権の確認は行いません。

いいねはPR TIMES上のアクション数で、人数やFacebook反応数ではありません。別のいいねAPIを取得できなければリクエストはエラーとなり、0で補完しません。facebook_like_count は取得元が返した場合のみ数値で、未提供は null です。Facebook・X・LINEの共有リンクは反応数を意味しません。

rankings list の各行は1始まりの rank を返します。比較時は ranking_type と source.observed_at を保存してください。現在のランキングにない過去記事を「人気がなかった」と判断したり、公開からの経過時間が違う記事のいいねをそのまま成果比較に使ったりしないでください。これらは反応の観測値であり、記事が良かった理由の因果説明ではありません。

必要な権限

APIキーではreadスコープが必要です。 プロバイダーのキーはサーバー側で管理します。

グローバルオプション

orc research prtimes では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。

関連項目