Debian Codegraph @

docs/dyn/content_v2_1.buyongoogleprograms.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.buyongoogleprograms.html">buyongoogleprograms</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#activate">activate(merchantId, regionCode, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, for example, when paused. This method is only available to selected merchants.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(merchantId, regionCode, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a status of the BoG program for your Merchant Center account.</p>
86 <p class="toc_element">
87 <code><a href="#onboard">onboard(merchantId, regionCode, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Onboards the BoG program in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.</p>
89 <p class="toc_element">
90 <code><a href="#patch">patch(merchantId, regionCode, body=None, updateMask=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Updates the status of the BoG program for your Merchant Center account.</p>
92 <p class="toc_element">
93 <code><a href="#pause">pause(merchantId, regionCode, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants.</p>
95 <p class="toc_element">
96 <code><a href="#requestreview">requestreview(merchantId, regionCode, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. This method is only available to selected merchants.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="activate">activate(merchantId, regionCode, body=None, x__xgafv=None)</code>
101 <pre>Reactivates the BoG program in your Merchant Center account. Moves the program to the active state when allowed, for example, when paused. This method is only available to selected merchants.
102
103 Args:
104 merchantId: string, Required. The ID of the account. (required)
105 regionCode: string, Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available. (required)
106 body: object, The request body.
107 The object takes the form of:
108
109 { # Request message for the ActivateProgram method.
110 }
111
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116 </pre>
117 </div>
118
119 <div class="method">
120 <code class="details" id="close">close()</code>
121 <pre>Close httplib2 connections.</pre>
122 </div>
123
124 <div class="method">
125 <code class="details" id="get">get(merchantId, regionCode, x__xgafv=None)</code>
126 <pre>Retrieves a status of the BoG program for your Merchant Center account.
127
128 Args:
129 merchantId: string, Required. The ID of the account. (required)
130 regionCode: string, Required. The Program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available. (required)
131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
135
136 Returns:
137 An object of the form:
138
139 { # Response message for the GetProgramStatus method.
140 &quot;businessModel&quot;: [ # The business models in which merchant participates.
141 &quot;A String&quot;,
142 ],
143 &quot;customerServicePendingEmail&quot;: &quot;A String&quot;, # The customer service pending email. After verification this field becomes empty.
144 &quot;customerServicePendingPhoneNumber&quot;: &quot;A String&quot;, # The pending phone number specified for BuyOnGoogle program. It might be different than account level phone number. In order to update this field the customer_service_pending_phone_region_code must also be set. After verification this field becomes empty.
145 &quot;customerServicePendingPhoneRegionCode&quot;: &quot;A String&quot;, # Two letter country code for the pending phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes. In order to update this field the customer_service_pending_phone_number must also be set. After verification this field becomes empty.
146 &quot;customerServiceVerifiedEmail&quot;: &quot;A String&quot;, # Output only. The customer service verified email.
147 &quot;customerServiceVerifiedPhoneNumber&quot;: &quot;A String&quot;, # Output only. The verified phone number specified for BuyOnGoogle program. It might be different than account level phone number.
148 &quot;customerServiceVerifiedPhoneRegionCode&quot;: &quot;A String&quot;, # Output only. Two letter country code for the verified phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes.
149 &quot;onlineSalesChannel&quot;: &quot;A String&quot;, # The channels through which the merchant is selling.
150 &quot;participationStage&quot;: &quot;A String&quot;, # Output only. The current participation stage for the program.
151 }</pre>
152 </div>
153
154 <div class="method">
155 <code class="details" id="onboard">onboard(merchantId, regionCode, body=None, x__xgafv=None)</code>
156 <pre>Onboards the BoG program in your Merchant Center account. By using this method, you agree to the [Terms of Service](https://merchants.google.com/mc/termsofservice/transactions/US/latest). Calling this method is only possible if the authenticated account is the same as the merchant id in the request. Calling this method multiple times will only accept Terms of Service if the latest version is not currently signed.
157
158 Args:
159 merchantId: string, Required. The ID of the account. (required)
160 regionCode: string, Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available. (required)
161 body: object, The request body.
162 The object takes the form of:
163
164 { # Request message for the OnboardProgram method.
165 &quot;customerServiceEmail&quot;: &quot;A String&quot;, # The customer service email.
166 }
167
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172 </pre>
173 </div>
174
175 <div class="method">
176 <code class="details" id="patch">patch(merchantId, regionCode, body=None, updateMask=None, x__xgafv=None)</code>
177 <pre>Updates the status of the BoG program for your Merchant Center account.
178
179 Args:
180 merchantId: string, Required. The ID of the account. (required)
181 regionCode: string, Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available. (required)
182 body: object, The request body.
183 The object takes the form of:
184
185 { # Response message for the GetProgramStatus method.
186 &quot;businessModel&quot;: [ # The business models in which merchant participates.
187 &quot;A String&quot;,
188 ],
189 &quot;customerServicePendingEmail&quot;: &quot;A String&quot;, # The customer service pending email. After verification this field becomes empty.
190 &quot;customerServicePendingPhoneNumber&quot;: &quot;A String&quot;, # The pending phone number specified for BuyOnGoogle program. It might be different than account level phone number. In order to update this field the customer_service_pending_phone_region_code must also be set. After verification this field becomes empty.
191 &quot;customerServicePendingPhoneRegionCode&quot;: &quot;A String&quot;, # Two letter country code for the pending phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes. In order to update this field the customer_service_pending_phone_number must also be set. After verification this field becomes empty.
192 &quot;customerServiceVerifiedEmail&quot;: &quot;A String&quot;, # Output only. The customer service verified email.
193 &quot;customerServiceVerifiedPhoneNumber&quot;: &quot;A String&quot;, # Output only. The verified phone number specified for BuyOnGoogle program. It might be different than account level phone number.
194 &quot;customerServiceVerifiedPhoneRegionCode&quot;: &quot;A String&quot;, # Output only. Two letter country code for the verified phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes.
195 &quot;onlineSalesChannel&quot;: &quot;A String&quot;, # The channels through which the merchant is selling.
196 &quot;participationStage&quot;: &quot;A String&quot;, # Output only. The current participation stage for the program.
197 }
198
199 updateMask: string, The list of fields to update. If the update mask is not provided, then all the fields set in buyOnGoogleProgramStatus will be updated. Clearing fields is only possible if update mask is provided.
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205 Returns:
206 An object of the form:
207
208 { # Response message for the GetProgramStatus method.
209 &quot;businessModel&quot;: [ # The business models in which merchant participates.
210 &quot;A String&quot;,
211 ],
212 &quot;customerServicePendingEmail&quot;: &quot;A String&quot;, # The customer service pending email. After verification this field becomes empty.
213 &quot;customerServicePendingPhoneNumber&quot;: &quot;A String&quot;, # The pending phone number specified for BuyOnGoogle program. It might be different than account level phone number. In order to update this field the customer_service_pending_phone_region_code must also be set. After verification this field becomes empty.
214 &quot;customerServicePendingPhoneRegionCode&quot;: &quot;A String&quot;, # Two letter country code for the pending phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes. In order to update this field the customer_service_pending_phone_number must also be set. After verification this field becomes empty.
215 &quot;customerServiceVerifiedEmail&quot;: &quot;A String&quot;, # Output only. The customer service verified email.
216 &quot;customerServiceVerifiedPhoneNumber&quot;: &quot;A String&quot;, # Output only. The verified phone number specified for BuyOnGoogle program. It might be different than account level phone number.
217 &quot;customerServiceVerifiedPhoneRegionCode&quot;: &quot;A String&quot;, # Output only. Two letter country code for the verified phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes.
218 &quot;onlineSalesChannel&quot;: &quot;A String&quot;, # The channels through which the merchant is selling.
219 &quot;participationStage&quot;: &quot;A String&quot;, # Output only. The current participation stage for the program.
220 }</pre>
221 </div>
222
223 <div class="method">
224 <code class="details" id="pause">pause(merchantId, regionCode, body=None, x__xgafv=None)</code>
225 <pre>Pauses the BoG program in your Merchant Center account. This method is only available to selected merchants.
226
227 Args:
228 merchantId: string, Required. The ID of the account. (required)
229 regionCode: string, Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available. (required)
230 body: object, The request body.
231 The object takes the form of:
232
233 { # Request message for the PauseProgram method.
234 }
235
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240 </pre>
241 </div>
242
243 <div class="method">
244 <code class="details" id="requestreview">requestreview(merchantId, regionCode, body=None, x__xgafv=None)</code>
245 <pre>Requests review and then activates the BoG program in your Merchant Center account for the first time. Moves the program to the REVIEW_PENDING state. This method is only available to selected merchants.
246
247 Args:
248 merchantId: string, Required. The ID of the account. (required)
249 regionCode: string, Required. The program region code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Currently only US is available. (required)
250 body: object, The request body.
251 The object takes the form of:
252
253 { # Request message for the RequestReviewProgram method.
254 }
255
256 x__xgafv: string, V1 error format.
257 Allowed values
258 1 - v1 error format
259 2 - v2 error format
260 </pre>
261 </div>
262
263 </body></html>