Skip to main content

buyongoogleprograms

Overview

Namebuyongoogleprograms
TypeResource
Idgoogledevelopers.content.buyongoogleprograms

Fields

NameDatatypeDescription
customerServiceVerifiedPhoneNumberstringOutput only. The verified phone number specified for BuyOnGoogle program. It might be different than account level phone number.
onlineSalesChannelstringThe channels through which the merchant is selling.
participationStagestringOutput only. The current participation stage for the program.
businessModelarrayThe business models in which merchant participates.
customerServiceVerifiedEmailstringOutput only. The customer service verified email.
customerServiceVerifiedPhoneRegionCodestringOutput only. Two letter country code for the verified phone number, for example CA for Canadian numbers. See the ISO 3166-1 alpha-2 officially assigned codes.
customerServicePendingEmailstringThe customer service pending email. After verification this field becomes empty.
customerServicePendingPhoneRegionCodestringTwo letter country code for the pending phone number, for example CA for Canadian numbers. See the ISO 3166-1 alpha-2 officially assigned codes. In order to update this field the customer_service_pending_phone_number must also be set. After verification this field becomes empty.
customerServicePendingPhoneNumberstringThe pending phone number specified for BuyOnGoogle program. It might be different than account level phone number. In order to update this field the customer_service_pending_phone_region_code must also be set. After verification this field becomes empty.

Methods

NameAccessible byRequired ParamsDescription
getSELECTmerchantId, regionCodeRetrieves a status of the BoG program for your Merchant Center account.
activateEXECmerchantId, regionCodeReactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, for example, when paused. This method is only available to selected merchants.
onboardEXECmerchantId, regionCodeOnboards the BoG program in your Merchant Center account. By using this method, you agree to the Terms of Service. Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.
patchEXECmerchantId, regionCodeUpdates the status of the BoG program for your Merchant Center account.
pauseEXECmerchantId, regionCodePauses the BoG program in your Merchant Center account. This method is only available to selected merchants.
requestreviewEXECmerchantId, regionCodeRequests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. This method is only available to selected merchants.