Merchant API (merchantapi:reviews_v1beta)

2024-10-16

8 new methods | New API

Additions

    Methods
  • merchantapi.accounts.merchantReviews.get

      Path: reviews/v1beta/{+name}

      Flat Path: reviews/v1beta/accounts/{accountsId}/merchantReviews/{merchantReviewsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}

          Pattern: ^accounts/[^/]+/merchantReviews/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets a merchant review.

  • merchantapi.accounts.merchantReviews.list

      Path: reviews/v1beta/{+parent}/merchantReviews

      Flat Path: reviews/v1beta/accounts/{accountsId}/merchantReviews

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The account to list merchant reviews for. Format: accounts/{account}

          Pattern: ^accounts/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. A page token, received from a previous `ListMerchantReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMerchantReviews` must match the call that provided the page token.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists merchant reviews.

  • merchantapi.accounts.merchantReviews.insert

      Path: reviews/v1beta/{+parent}/merchantReviews:insert

      Flat Path: reviews/v1beta/accounts/{accountsId}/merchantReviews:insert

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The account where the merchant review will be inserted. Format: accounts/{account}

          Pattern: ^accounts/[^/]+$

          Location: path

          Required: Yes

          Type: string

        dataSource

          Description: Required. The data source of the [merchantreview](https://support.google.com/merchants/answer/7045996?sjid=5253581244217581976-EU) Format: `accounts/{account}/dataSources/{datasource}`.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.

  • merchantapi.accounts.merchantReviews.delete

      Path: reviews/v1beta/{+name}

      Flat Path: reviews/v1beta/accounts/{accountsId}/merchantReviews/{merchantReviewsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}

          Pattern: ^accounts/[^/]+/merchantReviews/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Deletes merchant review.

  • merchantapi.accounts.productReviews.get

      Path: reviews/v1beta/{+name}

      Flat Path: reviews/v1beta/accounts/{accountsId}/productReviews/{productReviewsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The ID of the merchant review. Format: accounts/{account}/productReviews/{productReview}

          Pattern: ^accounts/[^/]+/productReviews/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets a product review.

  • merchantapi.accounts.productReviews.list

      Path: reviews/v1beta/{+parent}/productReviews

      Flat Path: reviews/v1beta/accounts/{accountsId}/productReviews

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The account to list product reviews for. Format: accounts/{account}

          Pattern: ^accounts/[^/]+$

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of products to return. The service may return fewer than this value.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. A page token, received from a previous `ListProductReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProductReviews` must match the call that provided the page token.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Lists product reviews.

  • merchantapi.accounts.productReviews.insert

      Path: reviews/v1beta/{+parent}/productReviews:insert

      Flat Path: reviews/v1beta/accounts/{accountsId}/productReviews:insert

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The account where the product review will be inserted. Format: accounts/{account}

          Pattern: ^accounts/[^/]+$

          Location: path

          Required: Yes

          Type: string

        dataSource

          Description: Required. Format: `accounts/{account}/dataSources/{datasource}`.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Inserts a product review.

  • merchantapi.accounts.productReviews.delete

      Path: reviews/v1beta/{+name}

      Flat Path: reviews/v1beta/accounts/{accountsId}/productReviews/{productReviewsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The ID of the Product review. Format: accounts/{account}/productReviews/{productReview}

          Pattern: ^accounts/[^/]+/productReviews/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Deletes a product review.