📈

【Shopify.dev和訳】Admin API/GraphQL reference/Common Objects①

2021/10/01に公開

GraphQL

API

Shopify

tech

この記事について

この記事は、Admin API/GraphQL reference Common Objectsの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

Shopify アプリである、「らくらく日本語フォント設定｜リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

Common APIs

Common Admin API objects です。

Overview

Activity — ショップのアクティビティの概要です。
ActivityTopic — アクティビティのトピックで、適切なアイコンまたはデフォルトのアイコンを表示するために使用します。
ApiVersion — API のバージョンです。
CountryCode — ISO 3166-1 alpha-2 の国別コード（一部異なる場合があります）。
CropRegion — 画像を Crop した後に残す部分。
CurrencyCode — 通貨コード。
Dimension — ディメンションを表します。(幅や高さなどのサイズ？)
GiftCard — ギフトカードを表します。
GiftCardCreateInput — ギフトカードを作成するための Input を表します。
GiftCardSortKeys — GiftCard query に有効なソートキーのセットです。
GiftCardUpdateInput — ギフトカードの更新 Input を表します。
HasMetafieldDefinitions — メタフィールドの定義が適用できるリソースです。
Image — 画像のリソースを表します。
ImageContentType — サポートされている画像の拡張子のリストです。
ImageInput — 画像の入力フィールドを指定します。
ImageUploadParameter — 画像アップロードのパラメーターです。
Job — ジョブは、クライアントがステータスをポーリングする必要のある長期タスクに対応します。
LegacyInteroperability — REST Admin API リソースに直接対応するタイプの相互運用性メタデータです。例）Product タイプでは、LegacyInteroperability は REST Admin API の対応する Product object のメタデータを返します。
LengthUnit — 長さの測定単位。
MailingAddress — 顧客の郵送先住所を表します。例えば、顧客のデフォルトの住所と注文の請求先住所は両方とも郵送先住所です。
MailingAddressInput — メーリング・アドレスの作成または更新に使用するフィールドを指定します。
MetafieldDefinitionInput — メタフィールド定義の入力フィールドを指定します。
MetafieldDefinitionOption — 構成されたメタフィールド定義のオプションです。
MetafieldDefinitionOptionAllowedDomains — メタフィールド定義の許容ドメイン・オプションの値です。
MetafieldDefinitionOptionFileTypeOptions — メタフィールド・スキーマのファイルタイプ・オプションの構成値です。
MetafieldDefinitionOptionInput — メタフィールド定義オプションのタイプと値です。
MetafieldDefinitionOptionMaxDate — メタフィールド定義の最大の日付オプション値です。
MetafieldDefinitionOptionMaxDateTime — メタフィールド定義の日付と時間のオプションの最大値です。
MetafieldDefinitionOptionMaxDecimal — Decimal のメタフィールド定義の最大値です。
MetafieldDefinitionOptionMaxDimension — Dimension メタフィールド定義の最大値です。
MetafieldDefinitionOptionMaxInteger — Integer メタフィールイド定義の最大値オプションです。
MetafieldDefinitionOptionMaxLength — メタフィールド定義の最大 length オプションの値です。
MetafieldDefinitionOptionMaxPrecision — メタフィールドスキーマの最大 precision configuration の値です。
MetafieldDefinitionOptionMaxRatingScale — Rating Scale メタフィールド定義の最大値です。
MetafieldDefinitionOptionMaxVolume — メタフィールド定義の最大 volume オプションの値です。
MetafieldDefinitionOptionMaxWeight — メタフィールド定義の最大 weight オプションの値です。
MetafieldDefinitionOptionMinDate — メタフィールド定義の最小の日付オプション値です。
MetafieldDefinitionOptionMinDateTime — メタフィールド定義の日付と時刻のオプションの最小値です。
MetafieldDefinitionOptionMinDecimal — Decimal のメタフィールド定義の最小値です。
MetafieldDefinitionOptionMinDimension — Dimension メタフィールド定義の最小値です。
MetafieldDefinitionOptionMinInteger — Integer メタフィールド定義の最小値です。
MetafieldDefinitionOptionMinLength — メタフィールド定義の最小 length のオプション値です。
MetafieldDefinitionOptionMinRatingScale — Rating Scale メタフィールド定義の最小値です。
MetafieldDefinitionOptionMinVolume — Volume メタフィールド定義オプションの最小値です。
MetafieldDefinitionOptionMinWeight — Weight メタフィールド定義オプションの最小値です。
MetafieldDefinitionOptionRegex — メタフィールド・スキーマの正規表現の構成値です。
MetafieldDefinitionOptionType — メタフィールド定義オプションのタイプです。
MetafieldDefinitionOptionValue — メタフィールド定義の構成のタイプと値です。
MetafieldDefinitionPinnedStatus — 可能なメタフィールド定義のピン留めステータス。
MetafieldDefinitionSortKeys — メタフィールド定義クエリの有効なソートキーのセットです。
MetafieldDefinitionType — メタフィールド定義タイプは、メタフィールドの基本的な基礎と Validation を提供します。
MetafieldDefinitionUpdateInput — メタフィールド定義の update mutation の入力フィールドを指定します。
MetafieldDefinitionValidationStatus — 可能なメタフィールド定義の Validation ステータス。
MoneyBag — 各通貨の金額のコレクション。
MoneyInput — 通貨付きの金額のフィールドを指定します。
MoneyV2 — 通貨付きの金額。
MutationsStagedUploadTargetGenerateUploadParameter — Shopify に Asset をアップロードするための署名入りアップロードパラメーターです。
Navigable — 結果をページングするためにクエリで使用できるデフォルトのカーソルです。コネクション内の各エッジは、コネクション内のエッジの位置への参照であるカーソルを返すことができます。エッジのカーソルを起点にして、接続内のエッジの前後のノードを取得できます。カーソルベースのページネーションの詳細については、GraphQL で結果をページネーションするを参照してください。
Node — グローバルな識別をサポートするための ID を持つオブジェクトです。
PaymentSchedule — 支払い条件で定義された 1 つの支払いに対する支払いスケジュールを表します。
PaymentScheduleInput — 支払い条件の支払いスケジュールを作成するために使用される入力フィールドです
PaymentTerms — オーダーまたはドラフトオーダーの支払い条件を表します。
PaymentTermsCreateInput — 支払条件を作成するために使用する入力フィールドです。
PaymentTermsDeleteInput — 支払条件を削除するために使用する入力フィールドです。
PaymentTermsInput — 支払条件を作成する際に使用する入力フィールドです。.
PaymentTermsTemplate — 支払条件テンプレートオブジェクトを表します。
PaymentTermsType — 支払条件または支払条件テンプレートのタイプです。
PaymentTermsUpdateInput — 支払条件の更新に使用する入力フィールドを指定します。
PubSubWebhookSubscriptionInput — PubSub Webhook サブスクリプションの入力フィールドを指定します。
QueryRoot — クエリのためのスキーマのエントリーポイントです。これは、すべてのクエリが開始されなければならないパブリックなトップレベル API として機能します。
SavedSearch — 保存された検索は、Admin に保存された検索クエリの表現です。
SavedSearchCreateInput — 保存された検索の作成に必要なフィールドを指定します。
SavedSearchDeleteInput — 保存された検索を削除するためのフィールドを指定します。
SavedSearchUpdateInput — 保存された検索結果を更新するために必要なフィールドを指定します。
SearchFilter — キーと value のペアで表される、検索クエリのフィルターです。
SearchFilterOptions — 検索フィルターのリストと、フィルタリングのための特定のオプション（値とラベルのペア）を指定します。
SearchResult — 検索から返される各結果を表します。
SearchResultType — 検索から返されるリソースのタイプを指定します。
StageImageInput — アップロードされる画像です。
StagedUploadHttpMethodType — ステージングされたターゲットの upload に利用可能な HTTP メソッド。
StagedUploadInput — アップロードされるメディアです。
StagedUploadParameter — メディアのアップロードパラメータ
StagedUploadTarget — ステージングされたターゲット情報.
StagedUploadTargetGenerateInput — Asset を Shopify にアップロードするために必要な URL とパラメータを生成するために必要なフィールドを指定します。
StagedUploadTargetGenerateUploadResource — 受け取るリソースタイプを指定します。
StandardMetafieldDefinitionTemplate — 標準のメタフィールド定義テンプレートは、メタフィールド定義のプリセット構成を提供します。
Volume — ボリュームの単位と値を表します。
VolumeUnit — ボリュームの単位です。
giftCardCreate — ギフトカードを作成します。
giftCardDisable — ギフトカードを無効にします
giftCardUpdate — ギフトカードを更新します。
metafieldDefinitionCreate — メタフィールド定義を作成します。
metafieldDefinitionDelete — メタフィールド定義を削除します。指定された場合は、関連するすべてのメタフィールドを非同期に削除します。
metafieldDefinitionUpdate — メタフィールド定義を更新します。
paymentAuthorizationSettingsUpdate — ショップの支払い承認設定を更新します。
paymentTermsCreate — 支払い条件を作成します。
paymentTermsDelete — 支払い条件を削除します。
paymentTermsUpdate — 支払い条件を更新します。
paymentsAppConfigure — パートナー管理ゲートウェイを加盟店に設定します。
pubSubWebhookSubscriptionCreate — 新しい Google Cloud Pub/Sub Webhook サブスクリプションを作成する。
pubSubWebhookSubscriptionUpdate — Google Cloud Pub/Sub Webhook サブスクリプションを更新します。
savedSearchCreate — 保存された検索を作成する
savedSearchDelete — 保存された検索を削除する
savedSearchUpdate — 保存された検索を更新する
stagedUploadTargetGenerate — Shopify にアセットをアップロードするために必要な URL と署名されたパラメータを生成します。
stagedUploadTargetsGenerate — 複数の画像をアップロードします。
stagedUploadsCreate — 各入力に対してステージングされたアップロードターゲットの URL を作成し、アップロードプロセスの最初のステップとなります。返された URL 付きのアップロードターゲットは、ファイルをアップロードするためのエンドポイントとして使用できます。
standardMetafieldDefinitionEnable — 指定された標準メタフィールド定義を有効にします。
tagsAdd — 注文、注文の下書き、顧客、商品、またはオンラインストアの記事にタグを追加します。
tagsRemove — タグ付け可能なオブジェクトからタグを削除します。

Shopify アプリのご紹介

Discussion

ログインするとコメントできます