Package google.shopping.merchant.promotions.v1beta

インデックス

PromotionsService

商品のプロモーションを管理するサービス。

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Merchant Center アカウントからプロモーションを取得します。

プロモーションの入力を挿入または更新した後、更新されたプロモーションを取得できるようになるまでに数分かかることがあります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳しくは、OAuth 2.0 の概要をご覧ください。
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Merchant Center アカウントのプロモーションを挿入します。プロモーションがすでに存在する場合は、代わりにプロモーションが更新されます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳しくは、OAuth 2.0 の概要をご覧ください。
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Merchant Center アカウントのプロモーションを一覧表示します。レスポンスには、pageSize で指定された項目よりも少ない項目が含まれる場合があります。pageToken を使用して、リクエストするアイテムが他にもあるかどうかを判断します。

プロモーションを挿入または更新した後、更新された処理済みのプロモーションを取得できるようになるまでに数分かかることがあります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳しくは、OAuth 2.0 の概要をご覧ください。

属性

属性。

フィールド
product_applicability

ProductApplicability

必須。すべての商品または特定の商品のみにプロモーションを適用するかどうか。
offer_type

OfferType

必須。プロモーションのタイプ。この属性を使用して、プロモーションを利用するのにクーポンコードが必要かどうかを指定します。
generic_redemption_code

string

省略可。プロモーションの汎用適用コード。offerType フィールドで使用し、最小要件を満たしている必要があります。
long_title

string

必須。プロモーションの長いタイトル。
coupon_value_type

CouponValueType

必須。実施しているプロモーションのタイプを示すクーポンの値タイプ属性。選択したクーポンの値のタイプによっては、一部の属性が必須となります。
promotion_destinations[]

DestinationEnum

必須。プロモーションが適用されるデスティネーションのリスト。データソースにサポートされている値を追加して掲載先を指定していない場合、プロモーションはショッピング広告と無料リスティングにデフォルトで表示されます。

商品の掲載先として、ショッピング アクション、Google 掲載、ローカル情報 Google 掲載の値を以前送信していた可能性があります。これらの値を表すには、FREE_LISTINGS、FREE_LOCAL_LISTINGS、LOCAL_INVENTORY_ADS を使用します。詳しくは、プロモーションのリンク先をご覧ください。
item_id_inclusion[]

string

省略可。プロモーションの商品アイテム ID で商品をフィルタします。商品フィルタ属性は、プロモーションの対象商品 product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
brand_inclusion[]

string

省略可。プロモーションのブランドで商品をフィルタします。商品フィルタ属性は、プロモーションの対象商品の product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
item_group_id_inclusion[]

string

省略可。プロモーションの商品アイテム ID による商品フィルタ。商品フィルタ属性は、プロモーションの対象商品 [product_applicability] 属性が specific_products に設定されている場合にのみ適用されます。
product_type_inclusion[]

string

省略可。プロモーションの商品カテゴリで商品をフィルタします。商品フィルタ属性は、プロモーションの対象商品 product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
item_id_exclusion[]

string

省略可。プロモーションの商品アイテム ID の除外による商品フィルタ。商品フィルタ属性は、プロモーションの対象商品 product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
brand_exclusion[]

string

省略可。プロモーションのブランド除外による商品フィルタ。商品フィルタ属性は、プロモーションの対象商品 product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
item_group_id_exclusion[]

string

省略可。商品グループ ID で商品をフィルタします。商品フィルタ属性は、プロモーションの対象商品 product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
product_type_exclusion[]

string

省略可。プロモーションの商品カテゴリの除外による商品フィルタ。商品フィルタ属性は、プロモーションの対象商品の product_applicability 属性が specific_products に設定されている場合にのみ適用されます。
minimum_purchase_amount

Price

省略可。プロモーションの最小購入金額。
minimum_purchase_quantity

int64

省略可。プロモーションの最小購入数量。
limit_quantity

int64

省略可。プロモーションの対象となる購入数の上限。
limit_value

Price

省略可。プロモーションの商品価格の上限。
percent_off

int64

省略可。プロモーションで提供される割引率。
money_off_amount

Price

省略可。プロモーションで提供される割引額。
get_this_quantity_discounted

int64

省略可。プロモーションで割引されるアイテムの数。この属性は、couponValueType が buy_m_get_n_money_off または buy_m_get_n_percent_off と等しい場合に設定されます。
free_gift_value

Price

省略可。プロモーションのプレゼントの金額。
free_gift_description

string

省略可。プロモーションのプレゼントの説明。
free_gift_item_id

string

省略可。プロモーションのプレゼント アイテム ID。
promotion_effective_time_period

Interval

必須。TimePeriod プロモーションの有効期間を表します。この属性は、この期間中にオンライン ショップでプロモーションをテストできることを指定します。
promotion_display_time_period

Interval

省略可。TimePeriod プロモーションの表示期間の表現。この属性では、プロモーションが Google.com とショッピング広告で公開される期間を指定します。プロモーションの表示期間 promotion_display_time_period 属性が指定されていない場合、プロモーションの有効期間 promotion_effective_time_period によって、プロモーションが Google.com とショッピング広告で公開される日付と期間が決まります。
store_applicability

StoreApplicability

省略可。プロモーションをすべての店舗に適用するか、指定した店舗のみに適用するか。店舗の適用性が指定されていない場合、ローカル在庫広告のプロモーションでエラーが発生します。store_applicability が ALL_STORES に設定され、store_codes_inclusion または score_code_exclusion が値に設定されている場合、INVALID_ARGUMENT エラーがスローされます。
store_codes_inclusion[]

string

省略可。プロモーションに含めるストアコード。店舗フィルタ属性は、store_applicability 属性が specific_stores に設定されている場合にのみ適用されます。

商品が販売されている実店舗の店舗コード（ビジネス プロフィールの店舗 ID）。詳しくは、ローカル商品在庫データの仕様をご覧ください。
store_codes_exclusion[]

string

省略可。プロモーションの除外する店舗コード。店舗のフィルタ属性は、store_applicability 属性が specific_stores に設定されている場合にのみ適用されます。
promotion_url

string

省略可。プロモーションが表示される販売者のサイトのページの URL。promotion_url が含まれていない場合、ローカル在庫広告のプロモーションでエラーが発生します。URL は、プロモーションが有効で利用可能であることを確認するために使用されます。

CouponValueType

プロモーションのクーポンの値タイプ。

列挙型
COUPON_VALUE_TYPE_UNSPECIFIED クーポンの値タイプが指定されていないことを示します。
MONEY_OFF 割引クーポンの値タイプ。
PERCENT_OFF 割引率のクーポンの値タイプ。
BUY_M_GET_N_MONEY_OFF M 個購入で N 割引クーポンの特典値タイプ。minimum_purchase_quantity と get_this_quantity_discounted が存在している必要があります。money_off_amount も存在している必要があります。
BUY_M_GET_N_PERCENT_OFF m 個購入で n% 割引のクーポン値タイプの値。minimum_purchase_quantity と get_this_quantity_discounted が存在している必要があります。percent_off_percentage も存在している必要があります。
BUY_M_GET_MONEY_OFF m 個購入で一定額割引。minimum_purchase_quantity と money_off_amount が存在している必要があります。
BUY_M_GET_PERCENT_OFF m 個購入で一定額割引。minimum_purchase_quantity と percent_off_percentage が存在している必要があります。
FREE_GIFT 説明のみのプレゼント。
FREE_GIFT_WITH_VALUE 金額が対象のプレゼント。
FREE_GIFT_WITH_ITEM_ID アイテム ID のプレゼント。
FREE_SHIPPING_STANDARD 標準の送料無料クーポンの値タイプ。
FREE_SHIPPING_OVERNIGHT 翌日配送の送料無料クーポンの値タイプ。
FREE_SHIPPING_TWO_DAY 2 日間送料無料クーポンの値タイプ。

GetPromotionRequest

GetPromotion メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。取得するプロモーションの名前。形式: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

InsertPromotion メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。プロモーションを挿入するアカウント。形式: accounts/{account}
promotion

Promotion

必須。挿入するプロモーション。
data_source

string

必須。プロモーション形式のデータソース: accounts/{account}/dataSources/{datasource}。

ListPromotionsRequest

ListPromotions メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。処理済みのプロモーションを一覧表示するアカウント。形式: accounts/{account}
page_size

int32

出力専用。返されるプロモーションの最大数。サービスが返す値はこれよりも少ないことがあります。最大値は 250 です。250 を超える値は 250 に強制変換されます。指定しない場合、プロモーションの最大数が返されます。
page_token

string

出力専用。前回の ListPromotions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListPromotions に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListPromotionsResponse

ListPromotions メソッドに対するレスポンス メッセージ。

フィールド
promotions[]

Promotion

指定したアカウントで処理されたプロモーション。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

OfferType

プロモーションのオファーの種類。

列挙型
OFFER_TYPE_UNSPECIFIED 不明なオファーの種類。
NO_CODE コードなしのオファータイプ。
GENERIC_CODE コード付きの特典タイプです。offerType = GENERIC_CODE の場合は、プロモーションの汎用適用コードが必要です。

ProductApplicability

プロモーションが適用される商品または商品リスト。

列挙型
PRODUCT_APPLICABILITY_UNSPECIFIED プロモーションが適用される商品が不明です。
ALL_PRODUCTS すべてのプロダクトが対象です。
SPECIFIC_PRODUCTS 1 つの商品または商品リストにのみ適用されます。

プロモーション

プロモーションを表します。詳しくは、次の記事をご覧ください。

データ検証チェックに合格するために必要なプロモーション入力属性は、主に以下で定義されています。

プロモーション入力を挿入または更新した後、最終的なプロモーションを取得できるようになるまでに数分かかることがあります。

フィールド
name

string

ID。プロモーションの名前。形式: accounts/{account}/promotions/{promotion}
promotion_id

string

必須。プロモーションを一意に識別する、ユーザー提供のプロモーション ID。プロモーションが不承認とならないように、最小要件を遵守してください。
content_language

string

必須。プロモーションの 2 文字の ISO 639-1 言語コード。

プロモーションは一部の言語でのみご利用いただけます。
target_country

string

必須。一意の識別子の一部として使用されるターゲット国。CLDR 地域コードで表されます。

プロモーションは一部の国でのみご利用いただけます。無料リスティングとショッピング広告、ローカル在庫広告、
redemption_channel[]

RedemptionChannel

必須。プロモーションの利用チャネル。チャネルが少なくとも 1 つ必要です。
data_source

string

出力専用。プロモーションのメイン データソース。
attributes

Attributes

省略可。プロモーション属性のリスト。
custom_attributes[]

CustomAttribute

省略可。カスタム（販売者指定）属性のリスト。また、データ仕様の任意の属性を汎用形式（{ "name": "size type", "value": "regular" } など）で送信する場合にも使用できます。これは、API で明示的に公開されていない属性を送信する場合に便利です。
promotion_status

PromotionStatus

出力専用。プロモーションのステータス、データ検証の問題、つまり非同期で計算されたプロモーションに関する情報。
version_number

int64

省略可。プロモーションの既存のバージョン（鮮度）を表します。複数の更新が同時に行われたときに正しい順序を保持するために使用できます。

設定すると、バージョン番号が既存のプロモーションの現在のバージョン番号より小さい場合、挿入がブロックされます。再挿入（30 日後のプロモーションの更新など）は、現在の version_number で実行できます。

オペレーションが防止された場合、中断された例外がスローされます。

PromotionStatus

プロモーションのステータス。

フィールド
destination_statuses[]

DestinationStatus

出力専用。プロモーションの掲載先。
item_level_issues[]

ItemLevelIssue

出力専用。プロモーションに関連する問題のリスト。
creation_date

Timestamp

出力専用。プロモーションが作成された日付（ISO 8601 形式: 日付、時刻、オフセット。例: 2020-01-02T09:00:00+01:00、2020-01-02T09:00:00Z）。
last_update_date

Timestamp

出力専用。プロモーション ステータスが最後に更新された日付（ISO 8601 形式）: 日付、時刻、オフセット（例: 2020-01-02T09:00:00+01:00、2020-01-02T09:00:00Z）

DestinationStatus

指定された宛先のステータス。

フィールド
reporting_context

ReportingContextEnum

出力専用。プロモーションのリンク先の名前。
status

State

出力専用。指定された宛先のステータス。

州

プロモーションの現在の状態。

列挙型
STATE_UNSPECIFIED プロモーションの状態が不明です。
IN_REVIEW プロモーションは審査中です。
REJECTED プロモーションが不承認です。
LIVE プロモーションが承認され、有効になっている。
STOPPED 販売者によってプロモーションが停止されています。
EXPIRED プロモーションは終了しています。
PENDING プロモーションは停止されておらず、すべての審査が承認されましたが、有効日が将来の日付です。

ItemLevelIssue

プロモーションに関連する問題。

フィールド
code

string

出力専用。問題のエラーコード。
severity

Severity

出力専用。この問題がプロモーションの提供に及ぼす影響
resolution

string

出力専用。販売者側で問題が解決可能かどうか。
attribute

string

出力専用。属性名（問題の原因が単一属性の場合）。
reporting_context

ReportingContextEnum

出力専用。問題が適用されるリンク先。
description

string

出力専用。問題の簡単な説明（英語）。
detail

string

出力専用。問題の詳細な説明（英語）。
documentation

string

出力専用。この問題の解決に役立つウェブページの URL。
applicable_countries[]

string

出力専用。問題が商品に適用される国コード（ISO 3166-1 alpha-2）のリスト。

重大度

問題の重大度。

列挙型
SEVERITY_UNSPECIFIED 指定されていません。
NOT_IMPACTED この問題は警告であり、プロモーションには直接影響しません。
DEMOTED プロモーションが降格され、検索結果でのパフォーマンスが制限される可能性が高い
DISAPPROVED 問題によりプロモーションが不承認になる。

RedemptionChannel

プロモーションのチャネル。

列挙型
REDEMPTION_CHANNEL_UNSPECIFIED チャネルが指定されていないことを示します。
IN_STORE チャンネルがストアにあることを示します。これは、products に使用されている local チャネルと同じです。
ONLINE チャネルがオンラインであることを示します。

StoreApplicability

プロモーションを適用する店舗コードまたは店舗コードのリスト。ローカル在庫広告のプロモーションにのみ使用できます。

列挙型
STORE_APPLICABILITY_UNSPECIFIED プロモーションが適用される店舗コードが不明です。
ALL_STORES プロモーションはすべての店舗に適用されます。
SPECIFIC_STORES プロモーションは指定した店舗にのみ適用されます。