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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<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> . <a href="content_v2_1.freelistingsprogram.checkoutsettings.html">checkoutsettings</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="#delete">delete(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enrolls merchant in `Checkout` program.</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="delete">delete(merchantId, x__xgafv=None)</code>
<pre>Deletes `Checkout` settings and unenrolls merchant from `Checkout` 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
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, x__xgafv=None)</code>
<pre>Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.
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:
{ # `CheckoutSettings` for a specific merchant ID.
"effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
"effectiveReviewState": "A String", # Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
"effectiveUriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
"cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
"checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
},
"enrollmentState": "A String", # Output only. Reflects the merchant enrollment state in `Checkout` feature.
"merchantId": "A String", # Required. The ID of the account.
"reviewState": "A String", # Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollment_state of `ENROLLED` before a review can begin for the merchant.
"uriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # URL settings for cart or checkout URL.
"cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
"checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code>
<pre>Enrolls merchant in `Checkout` program.
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 `InsertCheckoutSettings` method.
"uriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # Required. The `UrlSettings` for the request. The presence of URL settings indicates `Checkout` enrollment.
"cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
"checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # `CheckoutSettings` for a specific merchant ID.
"effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
"effectiveReviewState": "A String", # Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
"effectiveUriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.
"cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
"checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
},
"enrollmentState": "A String", # Output only. Reflects the merchant enrollment state in `Checkout` feature.
"merchantId": "A String", # Required. The ID of the account.
"reviewState": "A String", # Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollment_state of `ENROLLED` before a review can begin for the merchant.
"uriSettings": { # Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id) # URL settings for cart or checkout URL.
"cartUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.
"checkoutUriTemplate": "A String", # URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.
},
}</pre>
</div>
</body></html>
|
