Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop 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,
  "participationStage": enum (ProgramParticipationStage)
}
Fields
customerServiceVerifiedEmail

string

The customer service verified email.

customerServicePendingEmail

string

The customer service pending email.

participationStage

enum (ProgramParticipationStage)

The current participation stage for the program.

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.

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.

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.