Content API for Shopping . freelistingsprogram

Instance Methods

close()

Close httplib2 connections.

get(merchantId, x__xgafv=None)

Retrieves the status and review eligibility for the free listing program.

requestreview(merchantId, body=None, x__xgafv=None)

Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.

Method Details

close()
Close httplib2 connections.
get(merchantId, x__xgafv=None)
Retrieves the status and review eligibility for the free listing program.

Args:
  merchantId: string, Required. The ID of the account. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for GetFreeListingsProgramStatus.
  "regionStatuses": [ # Status of the program in each region. Regions with the same status and review eligibility are grouped together in `regionCodes`.
    { # Status of program and region.
      "disapprovalDate": "A String", # Date by which `eligibility_status` will go from `WARNING` to `DISAPPROVED`. It will be present when `eligibility_status` is `WARNING`. Date will be provided in ISO 8601 format i.e. YYYY-MM-DD
      "eligibilityStatus": "A String", # Eligibility status of the standard free listing program.
      "enhancedEligibilityStatus": "A String", # Eligibility status of the enhanced free listing program.
      "ineligibilityReason": "A String", # Reason if a program in a given country is not eligible for review. Populated only if `review_eligibility_status` is `INELIGIBLE`.
      "regionCodes": [ # The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes for all the regions with the same `eligibilityStatus` and `reviewEligibility`.
        "A String",
      ],
      "reviewEligibilityStatus": "A String", # If a program in a given country is eligible for review. It will be present only if eligibility status is `DISAPPROVED`.
      "reviewIssues": [ # These issues will be evaluated in review process. Fix all the issues before requesting the review.
        "A String",
      ],
    },
  ],
  "state": "A String", # If program is successfully onboarded for at least one region.
}
requestreview(merchantId, body=None, x__xgafv=None)
Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.

Args:
  merchantId: string, Required. The ID of the account. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the RequestReviewFreeListings Program method.
  "regionCode": "A String", # The code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country for which review is to be requested.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format