【Shopify.dev和訳】AdminAPI/GraphQL reference/Directives
この記事について
この記事は、AdminAPI/GraphQL reference/Directivesの記事を和訳したものです。
記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
概要 | Overview
Directives
ディレクティブは、GraphQL の実行者に対する追加オプションを記述します。これにより、GraphQL はディレクティブが提供する追加情報に基づいて、クエリやミューテーションの結果を変更することができます。
このセクションでは
-
accessRestricted - GraphQL スキーマの要素に、アクセス制限の注釈を付けます。
-
deprecated - GraphQL スキーマの要素に、サポートが終了したという注釈を付けます。
-
include -
if
引数が true の場合のみ、このフィールドまたはフラグメントを含めるように実行者に指示します。 -
skip -
if
引数が true の場合、このフィールドまたはフラグメントをスキップするように実行者に指示します。
accessRestricted
GraphQL スキーマの要素に、アクセス制限の注釈を付けます。
ロケーション
FIELD_DEFINITION
OBJECT
引数
引数 | 説明 |
---|---|
reason ( String ) |
この制限の理由を説明する 初期値: null
|
deprecated
GraphQL スキーマの要素に、サポート終了の注釈を付けます。
ロケーション
FIELD_DEFINITION
ENUM_VALUE
ARGUMENT_DEFINITION
INPUT_FIELD_DEFINITION
引数
引数 | 説明 |
---|---|
reason ( String ) |
この要素が非推奨になった理由を説明します。通常は、サポートされている類似データにアクセスする方法の提案も含みます。Markdownでフォーマットされています。 初期値: No longer supported
|
include
if
引数が true の場合にのみ、このフィールドまたはフラグメントを含めるように実行者に指示します。
ロケーション
FIELD
FRAGMENT_SPREAD
INLINE_FRAGMENT
引数
引数 | 説明 |
---|---|
if ( Boolean! ) 必須 |
真であれば含まれます。 |
skip
if
引数が true の場合に、このフィールドまたはフラグメントをスキップするように実行者に指示します。
ロケーション
FIELD
FRAGMENT_SPREAD
INLINE_FRAGMENT
引数
引数 | 説明 |
---|---|
if ( Boolean! ) 必須 |
true の場合はスキップされます。 |
Shopify アプリのご紹介
Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。
Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。
Discussion