• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.freelistingsprogram.html">freelistingsprogram</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#get">get(merchantId, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves the status and review eligibility for the free listing program.</p>
83<p class="toc_element">
84  <code><a href="#requestreview">requestreview(merchantId, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="close">close()</code>
89  <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93    <code class="details" id="get">get(merchantId, x__xgafv=None)</code>
94  <pre>Retrieves the status and review eligibility for the free listing program.
95
96Args:
97  merchantId: string, Required. The ID of the account. (required)
98  x__xgafv: string, V1 error format.
99    Allowed values
100      1 - v1 error format
101      2 - v2 error format
102
103Returns:
104  An object of the form:
105
106    { # Response message for GetFreeListingsProgramStatus.
107  &quot;regionStatuses&quot;: [ # Status of the program in each region. Regions with the same status and review eligibility are grouped together in `regionCodes`.
108    { # Status of program and region.
109      &quot;disapprovalDate&quot;: &quot;A String&quot;, # 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
110      &quot;eligibilityStatus&quot;: &quot;A String&quot;, # Eligibility status of the standard free listing program.
111      &quot;enhancedEligibilityStatus&quot;: &quot;A String&quot;, # Eligibility status of the enhanced free listing program.
112      &quot;ineligibilityReason&quot;: &quot;A String&quot;, # Reason if a program in a given country is not eligible for review. Populated only if `review_eligibility_status` is `INELIGIBLE`.
113      &quot;regionCodes&quot;: [ # 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`.
114        &quot;A String&quot;,
115      ],
116      &quot;reviewEligibilityStatus&quot;: &quot;A String&quot;, # If a program in a given country is eligible for review. It will be present only if eligibility status is `DISAPPROVED`.
117      &quot;reviewIssues&quot;: [ # These issues will be evaluated in review process. Fix all the issues before requesting the review.
118        &quot;A String&quot;,
119      ],
120    },
121  ],
122  &quot;state&quot;: &quot;A String&quot;, # If program is successfully onboarded for at least one region.
123}</pre>
124</div>
125
126<div class="method">
127    <code class="details" id="requestreview">requestreview(merchantId, body=None, x__xgafv=None)</code>
128  <pre>Requests a review for Free Listings program in the provided region. Important: This method is only whitelisted for selected merchants.
129
130Args:
131  merchantId: string, Required. The ID of the account. (required)
132  body: object, The request body.
133    The object takes the form of:
134
135{ # Request message for the RequestReviewFreeListings Program method.
136  &quot;regionCode&quot;: &quot;A String&quot;, # 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.
137}
138
139  x__xgafv: string, V1 error format.
140    Allowed values
141      1 - v1 error format
142      2 - v2 error format
143</pre>
144</div>
145
146</body></html>