Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 ended on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

REST Resource: buyongoogleprograms

Resource: BuyOnGoogleProgramStatus

Response message for the GetProgramStatus method.

JSON representation
{
  "customerServiceVerifiedEmail": string,
  "customerServicePendingEmail": string,
  "customerServicePendingPhoneRegionCode": string,
  "customerServicePendingPhoneNumber": string,
  "customerServiceVerifiedPhoneRegionCode": string,
  "customerServiceVerifiedPhoneNumber": string,
  "participationStage": enum (ProgramParticipationStage),
  "onlineSalesChannel": enum (OnlineSalesChannel),
  "businessModel": [
    enum (BusinessModel)
  ]
}
Fields
customerServiceVerifiedEmail

string

Output only. The customer service verified email.

customerServicePendingEmail

string

The customer service pending email. After verification this field becomes empty.

customerServicePendingPhoneRegionCode

string

Two 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 [customerServicePendingPhoneNumber][google.shopping.content.v2p1.Programs.BuyOnGoogleProgramStatus.customer_service_pending_phone_number] must also be set. After verification this field becomes empty.

customerServicePendingPhoneNumber

string

The pending phone number specified for BuyOnGoogle program. It might be different than account level phone number. In order to update this field the [customerServicePendingPhoneRegionCode][google.shopping.content.v2p1.Programs.BuyOnGoogleProgramStatus.customer_service_pending_phone_region_code] must also be set. After verification this field becomes empty.

customerServiceVerifiedPhoneRegionCode

string

Output 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.

customerServiceVerifiedPhoneNumber

string

Output only. The verified phone number specified for BuyOnGoogle program. It might be different than account level phone number.

participationStage

enum (ProgramParticipationStage)

Output only. The current participation stage for the program.

onlineSalesChannel

enum (OnlineSalesChannel)

The channels through which the merchant is selling.

businessModel[]

enum (BusinessModel)

The business models in which merchant participates.

ProgramParticipationStage

Enum representing the program participation stage.

Enums
PROGRAM_PARTICIPATION_STAGE_UNSPECIFIED Default value when participation stage is not set.
NOT_ELIGIBLE Merchant is not eligible for onboarding to a given program in a specific region code.
ELIGIBLE Merchant is eligible for onboarding to a given program in a specific region code.
ONBOARDING Merchant is onboarding to a given program in a specific region code.
ELIGIBLE_FOR_REVIEW Merchant fulfilled all the requirements and is ready to request review in a specific region code.
PENDING_REVIEW Merchant is waiting for the review to be completed in a specific region code.
REVIEW_DISAPPROVED The review for a merchant has been rejected in a specific region code.
ACTIVE Merchant's program participation is active for a specific region code.
PAUSED Participation has been paused.

OnlineSalesChannel

Enum representing online sales channel.

Enums
ONLINE_SALES_CHANNEL_UNSPECIFIED Default value when online sales channel is not set.
GOOGLE_EXCLUSIVE Merchant is selling exclusively on Google.
GOOGLE_AND_OTHER_WEBSITES Merchant is selling on Google and other websites.

BusinessModel

Enum representing business model.

Enums
BUSINESS_MODEL_UNSPECIFIED Default value when business model is not set.
MANUFACTURER Merchant is a manufacturer.
IMPORTER Merchant is an importer.
RESELLER Merchant is a reseller.
OTHER Merchant has a different business model.

Methods

activate

Reactivates the BoG program in your Merchant Center account.

get

Retrieves a status of the BoG program for your Merchant Center account.

onboard

Onboards the BoG program in your Merchant Center account.

patch

Updates the status of the BoG program for your Merchant Center account.

pause

Pauses the BoG program in your Merchant Center account.

requestreview

Requests review and then activates the BoG program in your Merchant Center account for the first time.