Package google.shopping.merchant.accounts.v1beta

インデックス

AccountIssueService

AccountIssueService API をサポートするサービス。

ListAccountIssues

rpc ListAccountIssues(ListAccountIssuesRequest) returns (ListAccountIssuesResponse)

Merchant Center アカウントのすべての問題が一覧表示されます。

認可スコープ

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

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

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

AccountsService

Accounts API をサポートするサービス。

CreateAndConfigureAccount

rpc CreateAndConfigureAccount(CreateAndConfigureAccountRequest) returns (Account)

追加設定を行ったスタンドアロンの Merchant Center アカウントを作成します。リクエストを行うユーザーを新しいアカウントの管理者として追加します。

認可スコープ

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

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

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

DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

タイプ(スタンドアロン、MCA、サブアカウント)に関係なく、指定したアカウントを削除します。MCA を削除すると、そのサブアカウントがすべて削除されます。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Merchant Center アカウントからアカウントを取得します。アカウントの挿入、更新、削除後、変更が有効になるまで数分かかることがあります。

認可スコープ

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

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

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

ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

呼び出し元のユーザーがアクセスでき、ページサイズやフィルタなどのリクエストの制約に一致するアカウントを一覧表示します。MCA のサブアカウントだけでなく、呼び出し元のユーザーがアクセスできるすべてのアカウント(他の MCA、リンクされたアカウント、スタンドアロン アカウントなど)が一覧表示されます。

認可スコープ

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

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

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

ListSubAccounts

rpc ListSubAccounts(ListSubAccountsRequest) returns (ListSubAccountsResponse)

指定されたマルチクライアント アカウントのすべてのサブアカウントを一覧表示します。これは、より強力な ListAccounts メソッドのコンビニエンス ラッパーです。このメソッドでは、relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION")) というフィルタで ListsAccounts を呼び出す場合と同じ結果が生成されます。

認可スコープ

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

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

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

UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

種類(スタンドアロン、MCA、サブアカウント)に関係なく、アカウントを更新します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

BusinessIdentityService

Business Identity API をサポートするサービス。

GetBusinessIdentity

rpc GetBusinessIdentity(GetBusinessIdentityRequest) returns (BusinessIdentity)

アカウントのビジネス アイデンティティを取得します。

認可スコープ

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

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

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

UpdateBusinessIdentity

rpc UpdateBusinessIdentity(UpdateBusinessIdentityRequest) returns (BusinessIdentity)

アカウントのビジネス アイデンティティを更新します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

BusinessInfoService

Business Info API をサポートするサービス。

GetBusinessInfo

rpc GetBusinessInfo(GetBusinessInfoRequest) returns (BusinessInfo)

アカウントのビジネス情報を取得します。

認可スコープ

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

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

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

UpdateBusinessInfo

rpc UpdateBusinessInfo(UpdateBusinessInfoRequest) returns (BusinessInfo)

アカウントのビジネス情報を更新します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

EmailPreferencesService

EmailPreferences API をサポートするサービス。

このサービスでは、認証されたユーザーのメール設定の取得と更新のみが許可されます。

GetEmailPreferences

rpc GetEmailPreferences(GetEmailPreferencesRequest) returns (EmailPreferences)

Merchant Center アカウント ユーザーのメール設定を返します。

認証されたユーザーの設定を取得するには、エイリアス name=accounts/*/users/me/emailPreferences を使用します。

認可スコープ

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

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

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

UpdateEmailPreferences

rpc UpdateEmailPreferences(UpdateEmailPreferencesRequest) returns (EmailPreferences)

Merchant Center アカウント ユーザーのメール設定を更新します。MCA のユーザーは、MCA のサブアカウントではなく、MCA アカウントを指定する必要があります。

更新マスクで明示的に選択されていない設定は更新されません。

未確認のオプトイン ステータス値をアップデートで指定することはできません。

認証されたユーザーの設定を更新するには、エイリアス name=accounts/*/users/me/emailPreferences を使用します。

認可スコープ

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

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

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

HomepageService

店舗のホームページ用 API をサポートするサービス。

ClaimHomepage

rpc ClaimHomepage(ClaimHomepageRequest) returns (Homepage)

ショップのホームページの申請。このメソッドを実行するには管理者権限が必要です。

ホームページがすでに申請されている場合は、オーナー確認が再度チェックされ(販売者が申請の免除と認定の免除対象である場合を除く)、成功したレスポンスが返されます。所有権を確認できなくなった場合、エラーが返されますが、申し立てはクリアされません。失敗した場合は、次のような正規のエラー メッセージが返されます。* PERMISSION_DENIED: user doesn't have the required permissions for this MC account;* FAILED_PRECONDITION: - アカウントは Merchant Center アカウントではありません。- MC アカウントにホームページがない- 申し立てに失敗しました(この場合は、エラー メッセージに詳細が表示されます)。

認可スコープ

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

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

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

GetHomepage

rpc GetHomepage(GetHomepageRequest) returns (Homepage)

ショップのホームページを取得します。

認可スコープ

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

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

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

UnclaimHomepage

rpc UnclaimHomepage(UnclaimHomepageRequest) returns (Homepage)

ショップのホームページの申請を解除します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

UpdateHomepage

rpc UpdateHomepage(UpdateHomepageRequest) returns (Homepage)

ショップのホームページを更新します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

OnlineReturnPolicyService

このサービスを利用すると、販売者の購入者都合による返品に関するポリシーの設定を管理しやすくなり、広告と無料リスティングの両方に適用される返品に関するポリシーを網羅できます。

学びますこの API では、次のリソースモデルを定義します。

[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]

GetOnlineReturnPolicy

rpc GetOnlineReturnPolicy(GetOnlineReturnPolicyRequest) returns (OnlineReturnPolicy)

既存の返品に関するポリシーを取得します。

認可スコープ

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

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

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

ListOnlineReturnPolicies

rpc ListOnlineReturnPolicies(ListOnlineReturnPoliciesRequest) returns (ListOnlineReturnPoliciesResponse)

返品に関する既存のポリシーを一覧表示します。

認可スコープ

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

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

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

ProgramsService

プログラム管理のためのサービス。

プログラムは、販売アカウントに機能を追加するメカニズムを提供します。その典型的な例が、販売者のショップの商品を Google の各種サービスに無料で掲載できる無料商品リスティング プログラムです。

このサービスでは、利用可能なすべてのプログラムへの販売者の参加状況を取得するメソッドのほか、各プログラムへの参加を明示的に有効または無効にするメソッドも公開されます。

DisableProgram

rpc DisableProgram(DisableProgramRequest) returns (Program)

アカウントの指定されたプログラムへの参加を無効にする。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

EnableProgram

rpc EnableProgram(EnableProgramRequest) returns (Program)

アカウントの指定されたプログラムへの参加を有効にします。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

GetProgram

rpc GetProgram(GetProgramRequest) returns (Program)

アカウントに指定されたプログラムを取得します。

認可スコープ

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

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

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

ListPrograms

rpc ListPrograms(ListProgramsRequest) returns (ListProgramsResponse)

アカウントのすべてのプログラムを取得します。

認可スコープ

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

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

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

RegionsService

リージョン構成を管理する。

この API では、次のリソースモデルを定義します。

  • Region
CreateRegion

rpc CreateRegion(CreateRegionRequest) returns (Region)

Merchant Center アカウントで地域の定義を作成します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

DeleteRegion

rpc DeleteRegion(DeleteRegionRequest) returns (Empty)

Merchant Center アカウントから地域の定義を削除します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

GetRegion

rpc GetRegion(GetRegionRequest) returns (Region)

Merchant Center アカウントで定義されている地域を取得します。

認可スコープ

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

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

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

ListRegions

rpc ListRegions(ListRegionsRequest) returns (ListRegionsResponse)

Merchant Center アカウントに登録されている地域が一覧表示されます。

認可スコープ

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

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

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

UpdateRegion

rpc UpdateRegion(UpdateRegionRequest) returns (Region)

Merchant Center アカウントの地域の定義を更新します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

ShippingSettingsService

販売者 API メソッドごとにメソッド呼び出しの配送設定情報を取得するサービス。

GetShippingSettings

rpc GetShippingSettings(GetShippingSettingsRequest) returns (ShippingSettings)

配送設定の情報を取得します。

認可スコープ

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

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

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

InsertShippingSettings

rpc InsertShippingSettings(InsertShippingSettingsRequest) returns (ShippingSettings)

販売者の送料設定を配送リクエストの設定に置き換えます。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

TermsOfServiceAgreementStateService

TermsOfServiceAgreementState API をサポートするサービス。

GetTermsOfServiceAgreementState

rpc GetTermsOfServiceAgreementState(GetTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

利用規約の状態を返します。

認可スコープ

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

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

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

RetrieveForApplicationTermsOfServiceAgreementState

rpc RetrieveForApplicationTermsOfServiceAgreementState(RetrieveForApplicationTermsOfServiceAgreementStateRequest) returns (TermsOfServiceAgreementState)

アプリケーションの利用規約に関する契約の状態を取得します。

認可スコープ

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

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

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

TermsOfServiceService

TermsOfService API をサポートするサービス。

AcceptTermsOfService

rpc AcceptTermsOfService(AcceptTermsOfServiceRequest) returns (Empty)

TermsOfService を受け入れます。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

GetTermsOfService

rpc GetTermsOfService(GetTermsOfServiceRequest) returns (TermsOfService)

指定されたバージョンに関連付けられている TermsOfService を取得します。

認可スコープ

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

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

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

RetrieveLatestTermsOfService

rpc RetrieveLatestTermsOfService(RetrieveLatestTermsOfServiceRequest) returns (TermsOfService)

指定された kindregion_codeTermsOfService の最新バージョンを取得します。

認可スコープ

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

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

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

UserService

ユーザー API をサポートするサービス。

CreateUser

rpc CreateUser(CreateUserRequest) returns (User)

Merchant Center アカウントのユーザーを作成します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

DeleteUser

rpc DeleteUser(DeleteUserRequest) returns (Empty)

Merchant Center アカウントのユーザーを削除します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

GetUser

rpc GetUser(GetUserRequest) returns (User)

Merchant Center アカウントのユーザーを取得します。

認可スコープ

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

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

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

ListUsers

rpc ListUsers(ListUsersRequest) returns (ListUsersResponse)

Merchant Center アカウントのすべてのユーザーを一覧表示します。

認可スコープ

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

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

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

UpdateUser

rpc UpdateUser(UpdateUserRequest) returns (User)

Merchant Center アカウントのユーザーを更新します。このメソッドを実行するには管理者権限が必要です。

認可スコープ

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

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

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

AcceptTermsOfServiceRequest

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

フィールド
name

string

必須。利用規約バージョンのリソース名。形式: termsOfService/{version}

account

string

必須。利用規約に同意するアカウント。

region_code

string

必須。CLDR で定義されているリージョン コード。利用規約が特定の国に適用される場合は「001」、全世界に適用される場合は「001」のいずれかになります。

承認済み

同意された利用規約を示します。

フィールド
terms_of_service

string

同意済みの termsOfService

accepted_by

string

承諾が記録されたアカウント。これは、アカウント自体、またはサブアカウントの場合は MCA アカウントです。

valid_until

Date

設定すると、同意された TermsOfService はこの日付の終わり(UTC)までのみ有効であることが指定されます。それまでに新しい ID に同意していただく必要があります。必須の TermsOfService は「Required」メッセージに記載されています。

AccessRight

アクセス権。

列挙型
ACCESS_RIGHT_UNSPECIFIED デフォルト値。この値は使用されません。
STANDARD 標準のアクセス権。
ADMIN 管理者権限。
PERFORMANCE_REPORTING この権限を持つユーザーは、パフォーマンスと分析情報にアクセスできます。

アカウント

アカウント。

フィールド
name

string

ID。アカウントのリソース名。形式: accounts/{account}

account_id

int64

出力専用。アカウントの ID。

account_name

string

必須。人が読める形式のアカウント名。詳しくは、店舗名お店やサービスの名前をご覧ください。

adult_content

bool

このアカウントにアダルト コンテンツが含まれているかどうか。

test_account

bool

出力専用。テスト アカウントかどうか。

time_zone

TimeZone

必須。アカウントのタイムゾーンです。

書き込み時、time_zonereporting_time_zonedisplay_time_zone の両方を設定します。

読み取りの場合、time_zone は常に display_time_zone を返します。アカウントに display_time_zone が存在しない場合、time_zone は空になります。

language_code

string

必須。アカウントの BCP-47 言語コードen-USsr-Latn など)。

AccountIssue

AccountIssue

フィールド
name

string

ID。アカウントの問題のリソース名。形式: accounts/{account}/issues/{id}

title

string

問題のローカライズされたタイトル。

severity

Severity

問題の全体的な重大度。

impacted_destinations[]

ImpactedDestination

この問題がさまざまなリンク先に与える影響。

detail

string

問題に関するローカライズされた詳細情報。

documentation_uri

string

問題とその解決方法に関する詳細情報を提供する Merchant Center ヘルプセンターへのリンク。

ImpactedDestination

問題がリンク先に及ぼす影響。

フィールド
impacts[]

Impact

指定されたデスティネーションのさまざまなリージョンに対する(負の)影響。

reporting_context

ReportingContextEnum

影響を受けるレポートのコンテキスト。

影響

問題が地域に与える影響。

フィールド
region_code

string

この問題が適用される CLDR リージョン コード

severity

Severity

宛先とリージョンにおける問題の重大度。

重大度

考えられるすべての重大度。

列挙型
SEVERITY_UNSPECIFIED 重大度は不明です。
CRITICAL この問題が原因で商品情報が配信されていない。
ERROR この問題は(今後の)クーポンに影響することもあれば、クーポンの問題を示している可能性もあります。
SUGGESTION 問題は改善の提案です。

住所

倉庫の配送先住所。

フィールド
street_address

string

住所の番地レベルの部分。例: 111w 31st Street

city

string

必須。市区町村。郵便区画や地区の下位区分(例: 地区、区画など)が含まれる場合もあります。

administrative_area

string

必須。国の最上位の行政区域。たとえば、カリフォルニア州(「CA」)やケベック州(「QC」)のような州です。

postal_code

string

必須。郵便番号(「94043」など)。

region_code

string

必須。CLDR 国コード(「US」など)。

BusinessDayConfig

倉庫の営業日。

フィールド
business_days[]

Weekday

必須。通常の営業日です。空にすることはできません。

平日

列挙型
WEEKDAY_UNSPECIFIED
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

BusinessIdentity

ビジネスのアイデンティティに関連する情報の収集。

フィールド
name

string

ID。ビジネス アイデンティティのリソース名。形式: accounts/{account}/businessIdentity

black_owned

IdentityAttribute

省略可。黒人のオーナーが所有または経営するビジネスであるかどうかを示す。このオプションのフィールドは、ビジネス拠点の国が US に設定されている販売者のみが使用できます。ショッピングモールやショッピングモールの販売者には適用されません。

women_owned

IdentityAttribute

省略可。女性のオーナーが所有または経営するビジネスを運営しているかどうかを指定します。このオプションのフィールドは、ビジネス拠点の国が US に設定されている販売者のみが使用できます。ショッピングモールやショッピングモールの販売者には適用されません。

veteran_owned

IdentityAttribute

省略可。ビジネスが退役軍人のオーナーが所有または経営するビジネスであるかどうかを指定します。このオプションのフィールドは、ビジネス拠点の国が US に設定されている販売者のみが使用できます。ショッピングモールやショッピングモールの販売者には適用されません。

latino_owned

IdentityAttribute

省略可。ラティーノのオーナーが所有または経営するビジネスであるかどうかを指定します。このオプションのフィールドは、ビジネス拠点の国が US に設定されている販売者のみが使用できます。ショッピングモールやショッピングモールの販売者には適用されません。

small_business

IdentityAttribute

省略可。ビジネスが小規模ビジネスであるかどうかを指定します。このオプションのフィールドは、ビジネス拠点の国が US に設定されている販売者のみが使用できます。また、ショッピングモールには適用されません。

IdentityAttribute

ID 属性に関連するすべての情報。

フィールド
identity_declaration

IdentityDeclaration

必須。この属性のアイデンティティの宣言。

IdentityDeclaration

身元の申告に関して可能なすべての設定。

列挙型
IDENTITY_DECLARATION_UNSPECIFIED 選択されていないことを示すデフォルト値。
SELF_IDENTIFIES_AS アカウントが属性で識別されることを示します。
DOES_NOT_SELF_IDENTIFY_AS アカウントが属性で識別されないことを示します。

PromotionsConsent

ビジネスのアイデンティティに関連するプロモーションに関するすべての設定です。

列挙型

BusinessInfo

ビジネスに関連する情報の収集。

フィールド
name

string

ID。ビジネス情報のリソース名。形式: accounts/{account}/businessInfo

address

PostalAddress

省略可。ビジネスの住所です。

phone

PhoneNumber

出力専用。ビジネスの電話番号。

phone_verification_state

PhoneVerificationState

出力専用。ビジネスの電話によるオーナー確認の状態です。

customer_service

CustomerService

省略可。ビジネスのカスタマー サービス。

korean_business_registration_number

string

省略可。10 桁の韓国の法人登録番号(ダッシュで区切った)。形式は XXX-XX-XXXXX です。

CarrierRate

main_table または single_value で参照できる運送業者の送料のリスト。

フィールド
name

string

必須。運送業者の送料の名前。料金グループごとに一意である必要があります。

carrier

string

必須。運送サービス("UPS""Fedex" など)。

carrier_service

string

必須。運送サービス("ground""2 days" など)。

origin_postal_code

string

必須。この運送業者の送料の発送元。

percentage_adjustment

string

省略可。10 進表記の数値で表した乗法送料調整比。負の値も使用できます。たとえば、"5.4" はレートを 5.4% 引き上げ、"-3" はレートを 3% 引き下げます。

flat_adjustment

Price

省略可。追加の送料調整比です。負の値も使用できます。たとえば、{ "amount_micros": 1, "currency_code" : "USD" } は料金に $1 を追加し、{ "amount_micros": -3, "currency_code" : "USD" } は料金から $3 を削除します。

ClaimHomepageRequest

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

フィールド
name

string

必須。申し立てを行うホームページの名前。形式: accounts/{account}/homepage

CreateAndConfigureAccountRequest

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

フィールド
account

Account

必須。作成するアカウント。

users[]

CreateUserRequest

省略可。アカウントに追加するユーザー。

service[]

AddAccountService

必須。作成するアカウントとプロバイダ アカウントの間のアカウント サービスは、作成の一環として初期化されます。そのようなサービスを少なくとも 1 つ提供する必要があります。現在サポートされているのは account_aggregation のみです。つまり、新しく作成されるアカウントは、account_aggregation サービスで定義されたプロバイダのサブアカウントになります。

accept_terms_of_service

AcceptTermsOfService

省略可。アカウント作成後すぐに利用規約に同意する利用規約。

AcceptTermsOfService

利用規約リソースへの参照。

フィールド
name

string

必須。利用規約バージョンのリソース名。

region_code

string

必須。CLDR で定義されているリージョン コード。利用規約が特定の国に適用される場合は001、全世界に適用されます。

AddAccountService

アカウントの作成時にアカウント サービスを追加するための追加の手順。

フィールド
共用体フィールド service_type。現在サポートされているのは、マルチクライアントの親アカウント タイプのみです。service_type は次のいずれかになります。
account_aggregation

Empty

プロバイダはアカウントのアグリゲータです。

provider

string

省略可。サービスのプロバイダ。形式: accounts/{account}

CreateRegionRequest

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

フィールド
parent

string

必須。地域を作成するアカウント。形式: accounts/{account}

region_id

string

必須。地域の識別子。同じアカウントのすべての地域にわたって一意です。

region

Region

必須。作成するリージョン。

CreateUserRequest

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

フィールド
parent

string

必須。ユーザーが作成されるアカウントのリソース名。形式: accounts/{account}

user_id

string

必須。ユーザーのメールアドレス(例: john.doe@gmail.com)。

user

User

必須。作成するユーザー。

CustomerService

カスタマー サービス情報。

フィールド
uri

string

省略可。カスタマー サービスが見つかる URI です。

email

string

省略可。カスタマー サービスに連絡できるメールアドレスです。

phone

PhoneNumber

省略可。カスタマー サービスの電話となる電話番号です。

CutoffTime

受付終了時間の定義(営業日単位)。

フィールド
hour

int32

必須。当日中に処理できる注文受付終了時間の時間。

minute

int32

必須。当日中に注文が処理されるまでの受付終了時間(分)です。

time_zone

string

必須。タイムゾーン識別子(例: Europe/Zurich)。

DeleteAccountRequest

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

フィールド
name

string

必須。削除するアカウントの名前。形式: accounts/{account}

DeleteRegionRequest

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

フィールド
name

string

必須。削除するリージョンの名前。形式: accounts/{account}/regions/{region}

DeleteUserRequest

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

フィールド
name

string

必須。削除するユーザーの名前。形式: accounts/{account}/users/{email}

accounts/{account}/users/me のようにメールアドレスではなく me を使用して、発信者に対応するユーザーを削除することもできます。

DeliveryTime

注文から商品の配送まで、さまざまな側面に費やされた時間。

フィールド
warehouse_based_delivery_times[]

WarehouseBasedDeliveryTime

省略可。選択した運送業者の設定に基づいて、倉庫(発送元の場所)ごとにお届け日数を計算する必要があることを示します。設定する場合は、[お届け日数][[google.shopping.content.bundles.ShippingSetting.DeliveryTime] のその他のお届け日数関連のフィールドを設定しないでください。

min_transit_days

int32

配送中の最短営業日数。0 は当日配達、1 は翌日配達を表します。min_transit_daysmax_transit_daystransit_time_table のいずれかを設定する必要があります。両方を設定することはできません。

max_transit_days

int32

配送中の最長営業日数。0 は当日配達、1 は翌日配達を表します。min_transit_days 以上の値を指定してください。

cutoff_time

CutoffTime

受付終了時間の定義(営業日単位)。設定しない場合、受付終了時間はデフォルトで午前 8 時(PST)に設定されます。

min_handling_days

int32

注文が発送されるまでの最短営業日数。0 は同日発送、1 は翌日発送を意味します。

max_handling_days

int32

注文が発送されるまでの最長営業日数。0 は同日発送、1 は翌日発送を意味します。min_handling_days 以上の値を指定してください。

transit_time_table

TransitTable

お届け日数の表、行と列のディメンションに基づくお届け日数(営業日)。min_transit_daysmax_transit_daystransit_time_table のいずれかを設定できますが、両方を設定することはできません。

handling_business_day_config

BusinessDayConfig

注文を処理できる営業日です。指定しなかった場合は、月曜日~金曜日の営業日と見なされます。

transit_business_day_config

BusinessDayConfig

注文を配送可能な営業日です。指定しなかった場合は、月曜日~金曜日の営業日と見なされます。

DisableProgramRequest

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

フィールド
name

string

必須。指定されたアカウントの参加を無効にするプログラムの名前。形式: accounts/{account}/programs/{program}

距離

配達可能な範囲(半径)を指定します。これは、ローカル配送の配送タイプの場合のみ必須です。

フィールド
value

int64

距離の整数値。

unit

Unit

単位は国によって異なる場合があり、マイルと km を含めるようにパラメータ化されています。

ユニット

単位は国によって異なる場合があり、マイルと km を含めるようにパラメータ化されています。

列挙型
UNIT_UNSPECIFIED 単位が指定されていません
MILES 単位(マイル)
KILOMETERS 単位(キロメートル)

EmailPreferences

ユーザーがオプトインまたはオプトアウトした通知のカテゴリ。メール設定には、ユーザーが無効にできないため、必須のお知らせは含まれません。

フィールド
name

string

ID。EmailPreferences の名前。エンドポイントは認証されたユーザーに対してのみサポートされます。

news_and_tips

OptInState

省略可。新機能、ヒント、ベスト プラクティスに関する最新情報。

OptInState

メール設定の状態を有効にします。

列挙型
OPT_IN_STATE_UNSPECIFIED オプトイン ステータスが指定されていません。
OPTED_OUT ユーザーがこの種のメールを受信しないよう選択しています。
OPTED_IN ユーザーがこの種類のメールを受信することを選択しています。
UNCONFIRMED ユーザーがこの種のメールの受信をオプトインし、確認メールが送信されましたが、ユーザーがまだオプトインを確認していません(特定の国にのみ適用)。

EnableProgramRequest

EnableProgram メソッドのリクエスト メッセージ。

フィールド
name

string

必須。指定されたアカウントの参加を有効にするプログラムの名前。形式: accounts/{account}/programs/{program}

GetAccountRequest

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

フィールド
name

string

必須。取得するアカウントの名前です。形式: accounts/{account}

GetBusinessIdentityRequest

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

フィールド
name

string

必須。ビジネス アイデンティティのリソース名。形式: accounts/{account}/businessIdentity

GetBusinessInfoRequest

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

フィールド
name

string

必須。ビジネス情報のリソース名。形式: accounts/{account}/businessInfo

GetEmailPreferencesRequest

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

フィールド
name

string

必須。EmailPreferences リソースの名前。形式: accounts/{account}/users/{email}/emailPreferences

GetHomepageRequest

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

フィールド
name

string

必須。取得するホームページの名前。形式: accounts/{account}/homepage

GetOnlineReturnPolicyRequest

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

フィールド
name

string

必須。取得する返品ポリシーの名前。形式: accounts/{account}/onlineReturnPolicies/{return_policy}

GetProgramRequest

GetProgram メソッドのリクエスト メッセージ。

フィールド
name

string

必須。取得するプログラムの名前。形式: accounts/{account}/programs/{program}

GetRegionRequest

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

フィールド
name

string

必須。取得するリージョンの名前。形式: accounts/{account}/regions/{region}

GetShippingSettingsRequest

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

フィールド
name

string

必須。取得する送料設定の名前。形式: accounts/{account}/shippingsetting

GetTermsOfServiceAgreementStateRequest

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

フィールド
name

string

必須。利用規約バージョンのリソース名。形式: accounts/{account}/termsOfServiceAgreementState/{identifier} 識別子の形式: {TermsOfServiceKind}-{country}

GetTermsOfServiceRequest

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

フィールド
name

string

必須。利用規約バージョンのリソース名。形式: termsOfService/{version}

GetUserRequest

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

フィールド
name

string

必須。取得するユーザーの名前。形式: accounts/{account}/users/{email}

accounts/{account}/users/me のようにメールアドレスではなく me を使用して、呼び出し元に対応するユーザーを取得することもできます。

ヘッダー

テーブルの行または列ヘッダーの空でないリスト。pricesweightsnum_itemspostal_code_group_nameslocation のいずれか 1 つのみを設定する必要があります。

フィールド
prices[]

Price

必須。注文価格の上限を含むリスト。最終価格の値は、price amount_micros = -1 に設定することで無限大にすることができます。たとえば、[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}] はヘッダー「<= $10」、「<= $500」、「>」を表します。500 ドル」とします。サービスの料金はすべて同じ通貨を使用する必要があります。空にすることはできません。-1 を除く正の値を指定してください。他のフィールドがすべて設定されていない場合にのみ設定できます。

weights[]

Weight

必須。包括的な注文の重みの上限のリスト。最後の重みの値は、price amount_micros = -1 に設定することで無限大にすることができます。たとえば、[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}] はヘッダー「<= 10kg」、「<= 50kg」、「>」を表します。50kg」としました。Service 内のすべての重みは同じ単位である必要があります。空にすることはできません。-1 を除く正の値を指定してください。他のフィールドがすべて設定されていない場合にのみ設定できます。

number_of_items[]

string

必須。アイテムの上限数を含むリスト。最後の値は "infinity" です。たとえば、["10", "50", "infinity"] はヘッダー「<= 10 items」、「<= 50 items」、「">」を表します。50 個のアイテムです。空にすることはできません。他のフィールドがすべて設定されていない場合にのみ設定できます。

postal_code_group_names[]

string

必須。郵便グループ名のリスト。最後の値は "all other locations" です。例: ["zone 1", "zone 2", "all other locations"]。参照される郵便番号グループは、サービスの配送先の国と一致している必要があります。空にすることはできません。他のフィールドがすべて設定されていない場合にのみ設定できます。

locations[]

LocationIdSet

必須。地域 ID セットのリストです。空にすることはできません。他のフィールドがすべて設定されていない場合にのみ設定できます。

ホームページ

店舗のホームページ。

フィールド
name

string

ID。店舗のホームページのリソース名。形式: accounts/{account}/homepage

claimed

bool

出力専用。ホームページが申請されているかどうか。詳しくは、https://support.google.com/merchants/answer/176793 をご覧ください。

uri

string

必須。ショップのホームページの URI(通常は URL)。

InsertShippingSettingsRequest

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

フィールド
parent

string

必須。この商品が挿入されるアカウント。形式: accounts/{account}

shipping_setting

ShippingSettings

必須。アカウントの新しいバージョン。

ListAccountIssuesRequest

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

フィールド
parent

string

必須。この問題のコレクションを所有する親。形式: accounts/{account}

page_size

int32

省略可。返される問題の最大数。サービスが返す値はこれよりも少ないことがあります。指定しない場合、最大で 50 ユーザーが返されます。最大値は 100 です。100 を超える値は 100 に強制変換されます

page_token

string

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

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

language_code

string

省略可。レスポンスの問題には、指定された言語の人が読める形式のフィールドが含まれます。形式は BCP-47en-USsr-Latn など)です。値を指定しない場合、en-US が使用されます。

time_zone

TimeZone

省略可。人が読める形式で時刻をローカライズするために使用される IANA タイムゾーン。例: 「America/Los_Angeles」。設定しない場合、「America/Los_Angeles」使用されます。

ListAccountIssuesResponse

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

フィールド
account_issues[]

AccountIssue

指定したアカウントの問題。

next_page_token

string

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

ListAccountsRequest

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

フィールド
page_size

int32

省略可。返されるアカウントの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 250 アカウントが返されます。最大値は 500 です。500 を超える値は 500 に強制変換されます。

page_token

string

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

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

filter

string

省略可。フィルタに一致するアカウントのみを返します。詳しくは、フィルタ構文のリファレンスをご覧ください。

ListAccountsResponse

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

フィールド
accounts[]

Account

ListAccountsRequest に一致するアカウント。

next_page_token

string

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

ListOnlineReturnPoliciesRequest

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

フィールド
parent

string

必須。返品に関するポリシーを一覧表示する販売アカウント。形式: accounts/{account}

page_size

int32

省略可。返される OnlineReturnPolicy リソースの最大数。指定された販売者の返品に関するポリシーの数が pageSize より少ない場合、サービスはこの値よりも少ない数を返します。デフォルト値は 10 です。最大値は 100 です。最大値より大きい値を指定すると、pageSize はデフォルトで最大値になります。

page_token

string

省略可。前回の ListOnlineReturnPolicies 呼び出しから受け取ったページトークン。後続のページを取得するためのページトークンを指定します。

ページ分割を行う場合、ListOnlineReturnPolicies に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。前のリクエストに対するレスポンスで nextPageToken として返されたトークン。

ListOnlineReturnPoliciesResponse

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

フィールド
online_return_policies[]

OnlineReturnPolicy

取得した返品ポリシー。

next_page_token

string

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

ListProgramsRequest

ListPrograms メソッドのリクエスト メッセージ。

フィールド
parent

string

必須。すべての番組を取得するアカウントの名前。形式: accounts/{account}

page_size

int32

省略可。1 回のレスポンスで返すプログラムの最大数。指定しない場合(または 0)、デフォルトのサイズである 1,000 が使用されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

省略可。前回の ListPrograms 呼び出しから受け取った継続トークン。次のページを取得するにはこれを指定します。

ListProgramsResponse

ListPrograms メソッドのレスポンス メッセージ。

フィールド
programs[]

Program

指定されたアカウントのプログラム。

next_page_token

string

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

ListRegionsRequest

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

フィールド
parent

string

必須。リージョンを一覧表示するアカウント。形式: accounts/{account}

page_size

int32

省略可。返されるリージョンの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 50 の地域が返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

page_token

string

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

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

ListRegionsResponse

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

フィールド
regions[]

Region

指定した販売者の地域。

next_page_token

string

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

ListSubAccountsRequest

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

フィールド
provider

string

必須。親アカウント。形式: accounts/{account}

page_size

int32

省略可。返されるアカウントの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 250 アカウントが返されます。最大値は 500 です。500 を超える値は 500 に強制変換されます。

page_token

string

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

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

ListSubAccountsResponse

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

フィールド
accounts[]

Account

指定された親アカウントがアグリゲータであるアカウント。

next_page_token

string

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

ListUsersRequest

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

フィールド
parent

string

必須。このユーザー コレクションを所有する親。形式: accounts/{account}

page_size

int32

省略可。返すユーザーの最大数。サービスが返す値はこれよりも少ないことがあります。指定しない場合、最大で 50 ユーザーが返されます。最大値は 100 です。100 を超える値は 100 に強制変換されます

page_token

string

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

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

ListUsersResponse

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

フィールド
users[]

User

指定したアカウントのユーザー。

next_page_token

string

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

LocationIdSet

地域 ID セットのリストです。空にすることはできません。他のフィールドがすべて設定されていない場合にのみ設定できます。

フィールド
location_ids[]

string

必須。地域 ID の空でないリスト。ロケーション タイプ(都道府県など)はすべて同じである必要があります。

MinimumOrderValueTable

受け取りに関するフルフィルメント タイプの店舗ごとの最低注文額の表。

フィールド
store_code_set_with_movs[]

StoreCodeSetWithMov

必須。同じ最低注文額(MOV)を共有する店舗コード セットのリスト。2 セット以上必須で、最後のセットは空にする必要があります。これは、「他のすべてのストアで MOV を使用する」ことを意味します。各店舗コードは、すべてのセットで 1 回だけ使用できます。サービスの料金はすべて同じ通貨を使用する必要があります。

StoreCodeSetWithMov

同じ最低注文額を共有する店舗コード セットのリスト。2 セット以上必須で、最後のセットは空にする必要があります。これは、「他のすべてのストアで MOV を使用する」ことを意味します。各店舗コードは、すべてのセットで 1 回だけ使用できます。サービスの料金はすべて同じ通貨を使用する必要があります。

フィールド
store_codes[]

string

省略可。一意の店舗コードのリスト、またはキャッチオールの場合は空。

value

Price

指定した店舗の最低注文額。

OnlineReturnPolicy

オンライン返品ポリシー オブジェクト。これは現在、広告や無料リスティング プログラムの返品に関するポリシーを表すために使用されます。

フィールド
name

string

ID。OnlineReturnPolicy リソースの名前。形式: accounts/{account}/onlineReturnPolicies/{return_policy}

return_policy_id

string

出力専用。Google が生成した返品に関するポリシー ID。

label

string

このフィールドは、ユーザーが定義した返品に関するポリシーの一意のラベルを表します。同じ国の返品に関するポリシーで、同じラベルを使用することはできません。プロダクトで特定のラベル属性が指定されていない限り、ポリシーには自動的に「デフォルト」のラベルが付けられます。特定の商品グループにカスタムの返品に関するポリシーを割り当てるには、返品に関するポリシーのラベルに記載されている手順に従ってください。ラベルには 50 文字まで入力できます。

countries[]

string

返品に関するポリシーが適用される販売先の国。値は 2 文字の有効な ISO 3166 コードである必要があります。

policy

Policy

返品に関するポリシー。

restocking_fee

RestockingFee

すべての返品理由カテゴリに適用される返品手数料。値が設定されていない場合、無料の払い戻し手数料として扱われます。

return_methods[]

ReturnMethod

購入者が商品を返品する方法を示す返品方法。返品に関するポリシーのタイプが noReturns である場合を除き、この値は空にできません。

item_conditions[]

ItemCondition

返品に関するポリシーのタイプが「noReturns」の場合を除き、返品を受け付ける商品の条件を空白にすることはできません。

return_shipping_fee

ReturnShippingFee

返品手数料。お客様が返品ラベルをダウンロードして印刷する必要がある場合にのみ設定する必要があります。

return_policy_uri

string

返品に関するポリシーの URI。これを使用して、Google はポリシーのサニティ チェックを実行できます。有効な URL を指定してください。

accept_defective_only

bool

このフィールドは必須であり、販売者が欠陥のある商品のみを返品して受け入れるかどうかを指定します。

process_refund_days

int32

このフィールドでは、販売者が払い戻しを処理するのにかかる日数を指定します。フィールドは省略可能です。

accept_exchange

bool

販売者がユーザーによる商品の交換を許可しているかどうかを示すフィールドです。必須フィールドです。

ItemCondition

購入可能なアイテムの条件。

列挙型
ITEM_CONDITION_UNSPECIFIED デフォルト値。この値は使用されません。
NEW 新規] をクリックします。
USED 使用済み。

ポリシー

使用可能なポリシー。

フィールド
type

Type

ポリシータイプ。

days

int64

配達後に商品を返品できる日数(配達のタイムスタンプから 24 時間後と定義)。NUMBER_OF_DAYS_AFTER_DELIVERY を返品する場合は必須です。

タイプ

返品に関するポリシーのタイプ。

列挙型
TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
NUMBER_OF_DAYS_AFTER_DELIVERY 商品が配達されてから、返品が有効な日数。
NO_RETURNS 返品できません。
LIFETIME_RETURNS 無期限に返品可能。

RestockingFee

払い戻し手数料。定額料金にすることも、マイクロパーセントの料金でも構いません。

フィールド

共用体フィールド type

type は次のいずれかになります。

fixed_fee

Price

固定の払い戻し手数料。

micro_percent

int32

合計金額に対する割合(マイクロ秒単位)。15,000,000 は、合計金額の 15% が請求されることを意味します。

ReturnMethod

利用可能なリターン メソッド。

列挙型
RETURN_METHOD_UNSPECIFIED デフォルト値。この値は使用されません。
BY_MAIL 郵送で返品する。
IN_STORE 店舗で返品する。
AT_A_KIOSK キオスクに戻ってきます。

ReturnShippingFee

返品手数料。固定料金、または購入者が実際の送料を支払うことを示すブール値のいずれかです。

フィールド
type

Type

返送料金のタイプ。

fixed_fee

Price

固定の返品送料。この値は、タイプが FIXED の場合にのみ適用されます。タイプが FIXED でこの値が設定されていない場合、返品送料が無料として扱われます。

タイプ

返品手数料のタイプ。

列挙型
TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
FIXED 返品送料は固定値です。
CUSTOMER_PAYING_ACTUAL_FEE 実際の返品手数料はお客様のご負担となります。

PhoneVerificationState

電話による確認の状態です。

列挙型
PHONE_VERIFICATION_STATE_UNSPECIFIED デフォルト値。この値は使用されません。
PHONE_VERIFICATION_STATE_VERIFIED 電話が確認されました。
PHONE_VERIFICATION_STATE_UNVERIFIED スマートフォンは未確認です

プログラム

指定されたアカウントの特定のプログラムへの参加を定義します。

プログラムは、販売アカウントに機能を追加するメカニズムを提供します。その典型的な例が、販売者のショップの商品を Google の各種サービスに無料で掲載できる無料商品リスティング プログラムです。

フィールド
name

string

ID。プログラムのリソース名。形式: accounts/{account}/programs/{program}

documentation_uri

string

出力専用。プログラムについて説明している Merchant Center ヘルプページの URL。

state

State

出力専用。アカウントのプログラムへの参加状態。

active_region_codes[]

string

出力専用。アカウントが積極的にプログラムに参加している地域。有効な地域とは、地域に影響するプログラム要件がすべて満たされている地域を指します。

リージョン コードは CLDR で定義されます。これは、プログラムがその国だけに適用される国、またはプログラムが全世界に適用される場合は001のいずれかです。

unmet_requirements[]

Requirement

出力専用。アカウントがまだ満たしておらず、プログラムへの参加に影響する要件。

要件

プログラムへの参加要件を定義します。

フィールド
title

string

出力専用。要件の名前。

documentation_uri

string

出力専用。要件について説明しているヘルプページの URL です。

affected_region_codes[]

string

出力専用。現在、この要件の影響を受けているリージョン。

リージョン コードは CLDR で定義されます。これは、プログラムがその国だけに適用される国、またはプログラムが全世界に適用される場合は001のいずれかです。

アカウントで考えられるプログラムへの参加状態。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は使用されません。
NOT_ELIGIBLE このアカウントではプログラムに参加できません。
ELIGIBLE アカウントがプログラムに参加できること。
ENABLED アカウントでプログラムが有効になります。

RateGroup

送料グループの定義。最後の 1 つのみに、空の applicable_shipping_labels(つまり「その他すべて」)を指定できます。他の applicable_shipping_labels を重複させることはできません。

フィールド
applicable_shipping_labels[]

string

必須。この料金グループを適用する商品を定義する送料ラベルのリスト。これは分離です。料金グループに適用するには、1 つのラベルが一致している必要があります。サービスの最後の料金グループの場合のみ、空にできます。

subtables[]

Table

省略可。main_table から参照されるサブテーブルのリスト。main_table が設定されている場合にのみ設定できます。

carrier_rates[]

CarrierRate

省略可。main_table または single_value で参照できる運送業者の送料のリスト。

single_value

Value

料金グループの値(例: 定額 $10)。main_tablesubtables が設定されていない場合のみ設定できます。

main_table

Table

料金グループを定義するテーブル(single_value では表現力が十分でない場合)。single_value が設定されていない場合のみ設定できます。

name

string

省略可。料金グループの名前。設定する場合は、配送サービス内で一意である必要があります。

地域

RegionalInventory サービスと ShippingSettings サービスの両方でターゲットとして使用できる地域を表します。地域は、郵便番号のコレクションとして定義することも、一部の国では定義済みの地域ターゲティングを使用して定義することもできます。詳しくは、地域を設定する をご覧ください。

フィールド
name

string

ID。リージョンのリソース名。形式: accounts/{account}/regions/{region}

postal_code_area

PostalCodeArea

省略可。地域を定義する郵便番号のリスト。

geotarget_area

GeoTargetArea

省略可。地域を定義する地域ターゲティングのリスト。

regional_inventory_eligible

BoolValue

出力専用。地域が地域別の在庫設定で使用できるかどうかを示します。

shipping_eligible

BoolValue

出力専用。地域が配送サービスの設定で使用可能かどうかを示します。

display_name

string

省略可。リージョンの表示名。

GeoTargetArea

地域を定義する地域ターゲティングのリスト。

フィールド
geotarget_criteria_ids[]

int64

必須。地域 ID の空でないリスト。ロケーション タイプ(都道府県など)はすべて同じである必要があります。

PostalCodeArea

地域を定義する郵便番号のリスト。注: 郵便番号を使用して定義されたすべての地域には、アカウントの ShippingSettings.postalCodeGroups リソースを使用してアクセスできます。

フィールド
region_code

string

必須。CLDR 地域コードまたは郵便番号グループが適用される国。

postal_codes[]

PostalCodeRange

必須。郵便番号の範囲。

PostalCodeRange

地域を定義する郵便番号の範囲。

フィールド
begin

string

必須。郵便番号または地域を定義する範囲の下限を示す接頭辞* のパターン。値の例: 941089410*9*

end

string

省略可。地域を定義する範囲の上限を示す郵便番号または prefix* 形式のパターン。postalCodeRangeStart と同じ長さにする必要があります。postalCodeRangeStart が郵便番号の場合は、postalCodeRangeEnd も郵便番号にする必要があります。postalCodeRangeStart がパターンの場合、postalCodeRangeEnd は同じプレフィックス長のパターンにする必要があります。省略可: 設定しない場合、この地域は「postalCodeRangeStart」に一致するすべての郵便番号として定義されます。

必須

同意が必要な利用規約を示します。

フィールド
terms_of_service

string

同意する必要がある termsOfService

tos_file_uri

string

利用規約ファイルの完全な URL。このフィールドは TermsOfService.file_uri と同じですが、説明のためだけに追加しています。

RetrieveForApplicationTermsOfServiceAgreementStateRequest

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

フィールド
parent

string

必須。TermsOfServiceAgreementState 形式を取得するアカウント: accounts/{account}

RetrieveLatestTermsOfServiceRequest

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

フィールド
region_code

string

CLDR で定義されているリージョン コード。利用規約が特定の国に適用される場合は「001」、全世界に適用される場合は「001」のいずれかになります。

kind

TermsOfServiceKind

この利用規約バージョンが適用される種類。

セルのリストを含めます。

フィールド
cells[]

Value

必須。行を構成するセルのリスト。2 次元の表では columnHeaders と同じ長さ、1 次元の表では 1 の長さにする必要があります。

サービス

配送サービス。

フィールド
delivery_countries[]

string

必須。サービスが適用される国の CLDR 地域コード。

rate_groups[]

RateGroup

省略可。送料グループの定義。最後の 1 つのみに、空の applicable_shipping_labels(つまり「その他すべて」)を指定できます。他の applicable_shipping_labels を重複させることはできません。

loyalty_programs[]

LoyaltyProgram

省略可。この配送サービスが限定されるポイント プログラム。

service_name

string

必須。サービスの自由形式名。移行先アカウント内で一意である必要があります。

active

bool

必須。配送サービスのアクティブ ステータスを公開するブール値。

currency_code

string

このサービスが適用される通貨の CLDR コード。料金グループの料金と一致している必要があります。

delivery_time

DeliveryTime

必須。注文から商品の配送まで、さまざまな側面に費やされた時間。

shipment_type

ShipmentType

このサービスで注文される配送先の種類です。

minimum_order_value

Price

このサービスの最低注文額。設定した場合、この金額以上を支払う必要があることを示します。サービスの料金はすべて同じ通貨を使用する必要があります。minimum_order_value_table と一緒に設定することはできません。

minimum_order_value_table

MinimumOrderValueTable

受け取りに関するフルフィルメント タイプの店舗ごとの最低注文額の表。minimum_order_value と一緒に設定することはできません。

store_config

StoreConfig

商品の発送元である店舗のリスト。これはローカル配送の配送タイプにのみ有効です。

LoyaltyProgram

販売者が提供するポイント プログラム

フィールド
loyalty_program_tiers[]

LoyaltyProgramTiers

省略可。この配送サービスのポイント プログラムの階層。

program_label

string

これは、Merchant Center のポイント プログラム設定で設定されているポイント プログラムのラベルです。このサブ属性を使用すると、貴社のポイント プログラムが対象の商品にマッピングされます。

LoyaltyProgramTiers

販売者のポイント プログラムのサブセット。

フィールド
tier_label

string

階層ラベル [tier_label] サブ属性は、商品単位の特典を階層間で区別します。この値は Merchant Center のプログラム設定でも設定されます。ポイント プログラムに階層が 1 つしかない場合でも、データソースの変更では必須です。

ShipmentType

配送サービスの配送タイプ。

列挙型
SHIPMENT_TYPE_UNSPECIFIED このサービスでは配送タイプが指定されていません。
DELIVERY このサービスでは、お客様が選択した住所に注文が発送されます。
LOCAL_DELIVERY このサービスでは、お客様が選択した住所に注文が発送されます。ご注文の商品はお近くの店舗から発送されます。
COLLECTION_POINT このサービスでは、お客様が選択した住所に注文が発送されます。注文は集荷所から発送されます。

StoreConfig

商品の発送元である店舗のリスト。これはローカル配送の配送タイプにのみ有効です。

フィールド
store_codes[]

string

省略可。ローカル配送を行う店舗コードのリストです。空の場合、all_stores は true にする必要があります。

store_service_type

StoreServiceType

この販売者が指定したすべての店舗または一部の店舗がローカル配送に対応しているかどうかを示します。

cutoff_config

CutoffConfig

当日のローカル配送終了に関する設定。

service_radius

Distance

配達可能な範囲(半径)を指定します。これは、ローカル配送の配送タイプの場合のみ必須です。

CutoffConfig

当日のローカル配送終了に関する設定。

フィールド
local_cutoff_time

LocalCutoffTime

当日のローカル配送の終了日時。

store_close_offset_hours

int64

ローカル配送フルフィルメントでのみ有効です。受付終了時間を、店舗が閉店するまでの時間数として表します。local_cutoff_time とは相互に排他的。

no_delivery_post_cutoff

bool

配送サービスが n 日以内のローカル配送に設定されている場合、販売者は n+1 日以内のローカル配送の表示を無効にできます。たとえば、配送サービスで当日配達が定義されていて、期限を過ぎている場合、このフィールドを true に設定すると、配送サービス料金の計算には NO_DELIVERY_POST_CUTOFF が返されます。同じ例で、このフィールドを false に設定すると、配送日数は 1 日として計算されます。これはローカル配送のみを対象としています。

LocalCutoffTime

当日のローカル配送の終了日時。

フィールド
hour

int64

時間指定ローカル配送の注文は、同日中に処理する必要があります。

minute

int64

同日に処理するには、ローカル配達の分単位の注文が必要です。

StoreServiceType

販売者が指定したすべての店舗または一部の店舗がローカル配送を提供しているかどうかを示します。

列挙型
STORE_SERVICE_TYPE_UNSPECIFIED 店舗のサービスタイプが指定されていません。
ALL_STORES この販売者が指定したすべての店舗(現在と将来)がローカル配送に対応しているかどうかを示します。
SELECTED_STORES store_codes にリストされている店舗のみがローカル配送の対象となることを示します。

ShippingSettings

販売アカウントの [送料設定](https://support.google.com/merchants/answer/6069284)

フィールド
name

string

ID。送料設定のリソース名。形式: accounts/{account}/shippingSetting

services[]

Service

省略可。移行先アカウントのサービスのリスト。

warehouses[]

Warehouse

省略可。services で参照できるウェアハウスのリスト。

etag

string

必須。このフィールドは非同期の問題を回避するために使用されます。呼び出しと挿入の間で配送設定データが変更されていないことを確認します。ユーザーは以下の手順を行う必要があります。

  1. 最初の送料設定を作成するには、etag フィールドを空の文字列に設定します。

  2. 最初の作成後、insert メソッドを呼び出して、ETag と現在の配送設定データを取得してから、insert を呼び出します。

  3. 必要な配送設定情報に変更します。

  4. ステップ 2 で取得した ETag を含む必要な送料設定情報を使用して、insert メソッドを呼び出します。

  5. ステップ 2 とステップ 4 で送料設定のデータが変更された場合。配送設定データが変更されるたびに ETag が変更されるため、挿入リクエストは失敗します。新しい ETag で手順 2 ~ 4 を繰り返す必要があります。

料金グループを定義するテーブル(single_value では表現力が十分でない場合)。

フィールド
rows[]

Row

必須。テーブルを構成する行のリスト。row_headers と同じ長さにする必要があります。

name

string

テーブルの名前。サブテーブルでは必須。メインのテーブルでは無視されます。

row_headers

Headers

必須。テーブルの行のヘッダー。

column_headers

Headers

テーブルの列のヘッダー。省略可: 設定しない場合、ディメンションは 1 つだけです。

TermsOfService

TermsOfService

フィールド
name

string

ID。利用規約バージョンのリソース名。形式: termsOfService/{version}

region_code

string

CLDR で定義されているリージョン コード。これは、利用規約が特にその国に適用される国か、どの国でも同じTermsOfServiceに署名できる場合は001です。ただし、世界全体に適用される利用規約に署名する際には、特定の国(販売者のビジネスの国またはプログラムに参加している国)を指定する必要があります。

kind

TermsOfServiceKind

この利用規約バージョンが適用される種類。

external

bool

この利用規約バージョンが外部向けかどうか。外部利用規約のバージョンへの同意は、外部プロセスを通じてのみ可能です。販売者が UI や API を通じて直接同意することはできません。

file_uri

string

署名するユーザーに表示する必要がある利用規約ファイルの URI。

TermsOfServiceAgreementState

このリソースは、特定のアカウントの契約状態と利用規約の種類を表します。状態は次のとおりです。

  • 販売者が利用規約に同意済みの場合: [Accepted] が入力されます。そうでない場合は空になります。
  • 販売者が利用規約に同意する必要がある場合は、required が入力されます。それ以外の場合は、空になります。

[required] と [Accepted] の両方を指定できます。この場合、accepted の利用規約の valid_until フィールドで有効期限が設定されます。アカウントで引き続き有効な契約を締結するには、valid_untilまでに required の利用規約に同意していただく必要があります。新しい利用規約に同意する際、サードパーティは所定の利用規約に関連付けられたテキストを表示することが求められます(そのテキストを含むファイルの URL が、以下の必須メッセージに tos_file_uri として追加されています)。実際に利用規約に同意するには、TermsOfService リソースの accept を呼び出します。

フィールド
name

string

ID。利用規約バージョンのリソース名。形式: accounts/{account}/termsOfServiceAgreementState/{identifier} 識別子の形式: {TermsOfServiceKind}-{country} たとえば、識別子は次のようになります。MERCHANT_CENTER-US

region_code

string

https://cldr.unicode.org/ で定義されているリージョン コード。現在の状態が適用される国です。

terms_of_service_kind

TermsOfServiceKind

特定のバージョンに関連付けられている利用規約の種類。

accepted

Accepted

このタイプの利用規約と、関連する region_code の利用規約

required

Required

必要な利用規約

TermsOfServiceKind

TermsOfService 種類。

列挙型
TERMS_OF_SERVICE_KIND_UNSPECIFIED デフォルト値。この値は使用されません。
MERCHANT_CENTER Merchant Center アプリケーション。

TransitTable

お届け日数の表、行と列のディメンションに基づくお届け日数(営業日)。min_transit_daysmax_transit_daystransit_time_table のいずれかを設定できますが、両方を設定することはできません。

フィールド
postal_code_group_names[]

string

必須。リージョン名 Region.name のリスト。最後の値は "all other locations" です。(例: ["zone 1", "zone 2", "all other locations"])。参照される郵便番号グループは、サービスの配送先の国と一致している必要があります。

transit_time_labels[]

string

必須。お届け日数ラベルのリスト。最後の値は "all other labels" です。例: ["food", "electronics", "all other labels"]

rows[]

TransitTimeRow

必須。postal_code_group_names または transit_time_labels のディメンション セットが 1 つしかない場合は、そのディメンションに 1 つの値を持つ行が複数あります。ディメンションが 2 つある場合は、各行が postal_code_group_names に対応し、列(値)が transit_time_labels に対応します。

TransitTimeRow

postal_code_group_names または transit_time_labels のディメンション セットが 1 つしかない場合は、そのディメンションに 1 つの値を持つ行が複数あります。ディメンションが 2 つある場合は、各行が postal_code_group_names に対応し、列(値)が transit_time_labels に対応します。

フィールド
values[]

TransitTimeValue

必須。お届け日数(最短~最長)(営業日数)。

TransitTimeValue

お届け日数(最短~最長)(営業日数)。

フィールド
min_transit_days

int32

最短お届け日数の範囲(営業日数)。0 は当日配達、1 は翌日配達を表します。

max_transit_days

int32

min_transit_days 以上の値を指定してください。

UnclaimHomepageRequest

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

フィールド
name

string

必須。申し立てを解除するホームページの名前。形式: accounts/{account}/homepage

UpdateAccountRequest

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

フィールド
account

Account

必須。アカウントの新しいバージョン。

update_mask

FieldMask

必須。更新するフィールドのリスト。

UpdateBusinessIdentityRequest

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

フィールド
business_identity

BusinessIdentity

必須。新しいバージョンのビジネス アイデンティティ。

update_mask

FieldMask

必須。更新するフィールドのリスト。

UpdateBusinessInfoRequest

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

フィールド
business_info

BusinessInfo

必須。新しいバージョンのビジネス情報。

update_mask

FieldMask

必須。更新するフィールドのリスト。

UpdateEmailPreferencesRequest

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

フィールド
email_preferences

EmailPreferences

必須。メール設定を更新します。

update_mask

FieldMask

必須。更新するフィールドのリスト。

UpdateHomepageRequest

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

フィールド
homepage

Homepage

必須。新しいバージョンのホームページ。

update_mask

FieldMask

必須。更新するフィールドのリスト。

UpdateRegionRequest

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

フィールド
region

Region

必須。更新されたリージョン。

update_mask

FieldMask

省略可。更新するフィールドを示すカンマ区切りのフィールド マスク。例: "displayName,postalCodeArea.regionCode"

UpdateUserRequest

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

フィールド
user

User

必須。ユーザーの新しいバージョン。

ご自身のメールアドレスを参照するには、me を使用します(例: accounts/{account}/users/me)。

update_mask

FieldMask

必須。更新するフィールドのリスト。

ユーザー

ユーザー

フィールド
name

string

ID。ユーザーのリソース名。形式: accounts/{account}/user/{email}

ご自身のメールアドレスを参照するには、me を使用します(例: accounts/{account}/users/me)。

state

State

出力専用。ユーザーの状態。

access_rights[]

AccessRight

省略可。ユーザーが持っているアクセス権

ユーザーの状態(ステータス)。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は使用されません。
PENDING ユーザーは確認を保留中です。この場合、ユーザーは他の操作を行う前に招待を承諾する必要があります。
VERIFIED ユーザーが確認されました。

料金グループの 1 つの値、または料金グループ表のセルの値。no_shippingflat_rateprice_percentagecarrier_rateNamesubtable_name のいずれか 1 つのみを設定する必要があります。

フィールド
no_shipping

bool

true の場合、商品を発送できません。設定する場合は true にする必要があります。他のすべてのフィールドが設定されていない場合のみ設定できます。

flat_rate

Price

定額料金。他のフィールドがすべて設定されていない場合にのみ設定できます。

price_percentage

string

10 進表記の数値で表される価格の割合(例: "5.4")。他のフィールドがすべて設定されていない場合にのみ設定できます。

carrier_rate

string

同じ送料グループで定義された運送業者の送料を参照する運送業者の送料の名前。他のフィールドがすべて設定されていない場合にのみ設定できます。

subtable

string

サブテーブルの名前。表のセルでのみ設定でき(たとえば、単一の値には設定できません)、他のすべてのフィールドが設定されていない場合のみ設定できます。

倉庫

在庫を保管、処理するフルフィルメント ウェアハウス。次のタグ: 7

フィールド
name

string

必須。ウェアハウスの名前。アカウント内で一意である必要があります。

shipping_address

Address

必須。倉庫の配送先住所。

cutoff_time

WarehouseCutoffTime

必須。注文を受け付けて処理を開始できる最新の時刻です。それより後の注文は翌日に処理されます。この時間は倉庫の郵便番号に基づきます。

handling_days

int64

必須。この倉庫で商品を梱包して発送するまでの日数。これは倉庫単位ですが、商品アイテムの属性に基づいて商品単位でオーバーライドできます。

business_day_config

BusinessDayConfig

倉庫の営業日。設定しない場合、デフォルトで月曜日から金曜日に設定されます。

WarehouseBasedDeliveryTime

選択した運送業者の設定に基づいて、倉庫(発送元の場所)ごとにお届け日数を計算する必要があることを示します。設定した場合、delivery_time のその他のお届け日数関連フィールドは設定しないでください。

フィールド
carrier

string

必須。携帯通信会社("UPS""Fedex" など)。

carrier_service

string

必須。運送サービス("ground""2 days" など)。サービスの名前は、eddSupportedServices リストに含まれている必要があります。

warehouse

string

必須。ウェアハウス名。[warehouse][ShippingSetting.warehouses.name] と一致する必要があります

WarehouseCutoffTime

注文を受け付けて処理を開始できる最新の時刻です。それより後の注文は翌日に処理されます。この時間は倉庫の郵便番号に基づきます。

フィールド
hour

int32

必須。倉庫で同日中に注文を処理するための受付終了時間の時間。時間は倉庫のタイムゾーンに基づきます。

minute

int32

必須。倉庫で同日中に注文を処理するための受付終了時間の分数。分はウェアハウスのタイムゾーンに基づきます。