class Buyongoogleprograms extends Resource (View source)

The "buyongoogleprograms" collection of methods.

Typical usage is:

 $contentService = new Google\Service\ShoppingContent(...);
 $buyongoogleprograms = $contentService->buyongoogleprograms;

Methods

activate(string $merchantId, string $regionCode, ActivateBuyOnGoogleProgramRequest $postBody, array $optParams = [])

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

get(string $merchantId, string $regionCode, array $optParams = [])

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

onboard(string $merchantId, string $regionCode, OnboardBuyOnGoogleProgramRequest $postBody, array $optParams = [])

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

patch(string $merchantId, string $regionCode, BuyOnGoogleProgramStatus $postBody, array $optParams = [])

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

pause(string $merchantId, string $regionCode, PauseBuyOnGoogleProgramRequest $postBody, array $optParams = [])

Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants. (buyongoogleprograms.pause)

requestreview(string $merchantId, string $regionCode, RequestReviewBuyOnGoogleProgramRequest $postBody, array $optParams = [])

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

Details

activate(string $merchantId, string $regionCode, ActivateBuyOnGoogleProgramRequest $postBody, array $optParams = [])

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

(buyongoogleprograms.activate)

Parameters

string $merchantId

Required. The ID of the account.

string $regionCode

Required. The program region code ISO 3166-1 alpha-2. Currently only US is available.

ActivateBuyOnGoogleProgramRequest $postBody
array $optParams

Optional parameters.

Exceptions

Exception

BuyOnGoogleProgramStatus get(string $merchantId, string $regionCode, array $optParams = [])

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

(buyongoogleprograms.get)

Parameters

string $merchantId

Required. The ID of the account.

string $regionCode

Required. The Program region code ISO 3166-1 alpha-2. Currently only US is available.

array $optParams

Optional parameters.

Return Value

BuyOnGoogleProgramStatus

Exceptions

Exception

onboard(string $merchantId, string $regionCode, OnboardBuyOnGoogleProgramRequest $postBody, array $optParams = [])

Onboards 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. (buyongoogleprograms.onboard)

Parameters

string $merchantId

Required. The ID of the account.

string $regionCode

Required. The program region code ISO 3166-1 alpha-2. Currently only US is available.

OnboardBuyOnGoogleProgramRequest $postBody
array $optParams

Optional parameters.

Exceptions

Exception

BuyOnGoogleProgramStatus patch(string $merchantId, string $regionCode, BuyOnGoogleProgramStatus $postBody, array $optParams = [])

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

(buyongoogleprograms.patch)

Parameters

string $merchantId

Required. The ID of the account.

string $regionCode

Required. The program region code ISO 3166-1 alpha-2. Currently only US is available.

BuyOnGoogleProgramStatus $postBody
array $optParams

Optional parameters.

Return Value

BuyOnGoogleProgramStatus

Exceptions

Exception

pause(string $merchantId, string $regionCode, PauseBuyOnGoogleProgramRequest $postBody, array $optParams = [])

Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants. (buyongoogleprograms.pause)

Parameters

string $merchantId

Required. The ID of the account.

string $regionCode

Required. The program region code ISO 3166-1 alpha-2. Currently only US is available.

PauseBuyOnGoogleProgramRequest $postBody
array $optParams

Optional parameters.

Exceptions

Exception

requestreview(string $merchantId, string $regionCode, RequestReviewBuyOnGoogleProgramRequest $postBody, array $optParams = [])

Requests 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. (buyongoogleprograms.requestreview)

Parameters

string $merchantId

Required. The ID of the account.

string $regionCode

Required. The program region code ISO 3166-1 alpha-2. Currently only US is available.

RequestReviewBuyOnGoogleProgramRequest $postBody
array $optParams

Optional parameters.

Exceptions

Exception