WordPress REST API を介した AIOSEO データの取得と更新

REST API アドオン(AIOSEO 4.1.9 で導入)は、すべての Plus、Pro、Elite プランのユーザーが利用でき、REST API を介して AIOSEO データを簡単に取得および更新できます。

これは、たとえば次のような場合に特に役立ちます。

  • ヘッドレス WordPress サイトで、フロントエンドで SEO データを手動で出力する必要がある場合。
  • 投稿を管理するためのサードパーティシステム(例:WooCommerce 連携を備えた eコマース ERP)があり、そのシステムを介して SEO データを管理できるようにしたい場合。

以下に、REST API を介して利用可能なデータと、それを更新する方法を説明します。

データの取得

カスタムエンドポイントを登録する代わりに、REST API アドオンは WordPress Core のデフォルトのエンドポイントと統合されます。現在、すべての GET post および term ルートがサポートされています。

これらには以下が含まれます:

  • /wp/v2/posts
  • /wp/v2/pages
  • /wp/v2/media
  • /wp/v2/categories
  • /wp/v2/tags

また、ウェブサイト上のカスタム投稿タイプおよびカスタムタクソノミーで、REST API のサポートが有効になっているすべてのルートも対象となります。

これらのルートの応答に含まれるフィールドは次のとおりです。

aioseo_head

このフィールドには、通常 All in One SEO が投稿/タームのソースコードにテキスト文字列として出力する生の SEO データが含まれます。

ヘッドレス WordPress ウェブサイトをお持ちの場合、このデータをインストールしたフロントエンドのソースコードに直接出力できます。

aioseo_head_json

このフィールドには、aioseo_head データ(上記参照)と同じ値が含まれますが、JSON 形式です。

これにより、ソースコードに出力する前や他の目的で使用する前に、データを簡単にフィルタリングできます。

これらの値が使用されるメタタグの HTML コードは含まれていないため、ご自身で構築する必要があることに注意してください。

aioseo_meta_data

このフィールドには、AIOSEO のカスタム投稿およびタームテーブルに JSON 形式で格納されているデータが含まれます。

このデータは、主に既存のデータを操作してウェブサイトに更新したい場合に使用する必要があります。

データの更新

REST API を介してデータを更新するには、認証する必要があります。方法がわからない場合は、WordPress REST API ドキュメントをお読みください

REST API経由でAIOSEOデータを更新するには、認証済みのユーザーも以下のいずれかの権限を持っている必要があります。

  • aioseo_page_general_settings
  • aioseo_page_social_settings
  • aioseo_page_schema_settings
  • aioseo_page_advanced_settings

これらの要件を満たしたら、リクエストのボディにaioseo_meta_dataプロパティを追加して、POST/PUTリクエストでデータを更新できます。

このプロパティ内では、aioseo_meta_dataフィールドに含まれるキー(上記参照)と新しい値を指定できます。

以下は、これがどのように見えるかの例です。

{
	"aioseo_meta_data": {
		"title":"NEW TITLE",
		"description":"NEW DESCRIPTION"
	}
}

REST APIについてご不明な点がございましたら、お気軽にサポートチームにお問い合わせください。喜んでお手伝いさせていただきます。