| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.freelistingsprogram.html">freelistingsprogram</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(merchantId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the status and review eligibility for the free listing program.</p> |
| <p class="toc_element"> |
| <code><a href="#requestreview">requestreview(merchantId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(merchantId, x__xgafv=None)</code> |
| <pre>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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="requestreview">requestreview(merchantId, body=None, x__xgafv=None)</code> |
| <pre>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 |
| </pre> |
| </div> |
| |
| </body></html> |
