-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
content_v2_1.freelistingsprogram.html
157 lines (132 loc) 路 5.68 KB
/
content_v2_1.freelistingsprogram.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<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="content_v2_1.freelistingsprogram.checkoutsettings.html">checkoutsettings()</a></code>
</p>
<p class="firstline">Returns the checkoutsettings Resource.</p>
<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. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use `accountstatuses` to view all issues for an account.</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 of free listings in a specific region. This method is only available to 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. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use `accountstatuses` to view all issues for an account.
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.
"globalState": "A String", # State of the program. `ENABLED` if there are offers for at least one region.
"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 eligibilityStatus will go from `WARNING` to `DISAPPROVED`. Only visible when your eligibilityStatus is WARNING. In [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DD`.
"eligibilityStatus": "A String", # Eligibility status of the standard free listing program.
"onboardingIssues": [ # Issues that must be fixed to be eligible for review.
"A String",
],
"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 is eligible for review in a specific region. Only visible if `eligibilityStatus` is `DISAPPROVED`.
"reviewIneligibilityReason": "A String", # Review ineligibility reason if account is not eligible for review.
"reviewIneligibilityReasonDescription": "A String", # Reason a program in a specific region isn鈥檛 eligible for review. Only visible if `reviewEligibilityStatus` is `INELIGIBLE`.
"reviewIneligibilityReasonDetails": { # Additional details for review ineligibility reasons. # Additional information for ineligibility. If `reviewIneligibilityReason` is `IN_COOLDOWN_PERIOD`, a timestamp for the end of the cooldown period is provided.
"cooldownTime": "A String", # This timestamp represents end of cooldown period for review ineligbility reason `IN_COOLDOWN_PERIOD`.
},
"reviewIssues": [ # Issues evaluated in the review process. Fix all issues before requesting a review.
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="requestreview">requestreview(merchantId, body=None, x__xgafv=None)</code>
<pre>Requests a review of free listings in a specific region. This method is only available to 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>