Skip to content

Commit 0cbd9d2

Browse files
chore(content_v2): update the api
1 parent 80558ac commit 0cbd9d2

File tree

2 files changed

+75
-8
lines changed

2 files changed

+75
-8
lines changed

docs/dyn/content_v2_1.accounts.html

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h2>Instance Methods</h2>
136136
<p class="firstline">Updates labels that are assigned to the Merchant Center account by CSS user.</p>
137137
<p class="toc_element">
138138
<code><a href="#verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
139-
<p class="firstline">Validates verification code to verify phone number for the account.</p>
139+
<p class="firstline">Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number.</p>
140140
<h3>Method Details</h3>
141141
<div class="method">
142142
<code class="details" id="authinfo">authinfo(x__xgafv=None)</code>
@@ -224,6 +224,7 @@ <h3>Method Details</h3>
224224
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
225225
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
226226
},
227+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
227228
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
228229
},
229230
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -314,6 +315,7 @@ <h3>Method Details</h3>
314315
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
315316
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
316317
},
318+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
317319
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
318320
},
319321
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -424,6 +426,7 @@ <h3>Method Details</h3>
424426
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
425427
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
426428
},
429+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
427430
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
428431
},
429432
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -492,6 +495,7 @@ <h3>Method Details</h3>
492495
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
493496
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
494497
},
498+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
495499
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
496500
},
497501
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -558,6 +562,7 @@ <h3>Method Details</h3>
558562
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
559563
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
560564
},
565+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
561566
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
562567
},
563568
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -679,6 +684,7 @@ <h3>Method Details</h3>
679684
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
680685
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
681686
},
687+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
682688
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
683689
},
684690
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -842,6 +848,7 @@ <h3>Method Details</h3>
842848
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
843849
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
844850
},
851+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
845852
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
846853
},
847854
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -908,6 +915,7 @@ <h3>Method Details</h3>
908915
&quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
909916
&quot;url&quot;: &quot;A String&quot;, # Customer service URL.
910917
},
918+
&quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
911919
&quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
912920
},
913921
&quot;cssId&quot;: &quot;A String&quot;, # ID of CSS the account belongs to.
@@ -973,7 +981,7 @@ <h3>Method Details</h3>
973981

974982
<div class="method">
975983
<code class="details" id="verifyphonenumber">verifyphonenumber(merchantId, accountId, body=None, x__xgafv=None)</code>
976-
<pre>Validates verification code to verify phone number for the account.
984+
<pre>Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number.
977985

978986
Args:
979987
merchantId: string, Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. (required)
@@ -996,7 +1004,7 @@ <h3>Method Details</h3>
9961004
An object of the form:
9971005

9981006
{ # Response message for the VerifyPhoneNumber method.
999-
&quot;verifiedPhoneNumber&quot;: &quot;A String&quot;, # Verified phone number if verification is successful.
1007+
&quot;verifiedPhoneNumber&quot;: &quot;A String&quot;, # Verified phone number if verification is successful. This phone number can only be replaced by another verified phone number.
10001008
}</pre>
10011009
</div>
10021010

docs/dyn/content_v2_1.buyongoogleprograms.html

Lines changed: 64 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ <h2>Instance Methods</h2>
8686
<p class="toc_element">
8787
<code><a href="#onboard">onboard(merchantId, regionCode, body=None, x__xgafv=None)</a></code></p>
8888
<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>
8992
<p class="toc_element">
9093
<code><a href="#pause">pause(merchantId, regionCode, body=None, x__xgafv=None)</a></code></p>
9194
<p class="firstline">Pauses the BoG program in your Merchant Center account. Important: This method is only whitelisted for selected merchants.</p>
@@ -99,7 +102,7 @@ <h3>Method Details</h3>
99102

100103
Args:
101104
merchantId: string, Required. The ID of the account. (required)
102-
regionCode: string, 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)
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)
103106
body: object, The request body.
104107
The object takes the form of:
105108

@@ -124,7 +127,7 @@ <h3>Method Details</h3>
124127

125128
Args:
126129
merchantId: string, Required. The ID of the account. (required)
127-
regionCode: string, 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)
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)
128131
x__xgafv: string, V1 error format.
129132
Allowed values
130133
1 - v1 error format
@@ -134,8 +137,16 @@ <h3>Method Details</h3>
134137
An object of the form:
135138

136139
{ # Response message for the GetProgramStatus method.
140+
&quot;businessModel&quot;: [ # The business models in which merchant participates.
141+
&quot;A String&quot;,
142+
],
137143
&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.
138146
&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.
139150
&quot;participationStage&quot;: &quot;A String&quot;, # Output only. The current participation stage for the program.
140151
}</pre>
141152
</div>
@@ -146,7 +157,7 @@ <h3>Method Details</h3>
146157

147158
Args:
148159
merchantId: string, Required. The ID of the account. (required)
149-
regionCode: string, 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)
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)
150161
body: object, The request body.
151162
The object takes the form of:
152163

@@ -161,13 +172,61 @@ <h3>Method Details</h3>
161172
</pre>
162173
</div>
163174

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+
164223
<div class="method">
165224
<code class="details" id="pause">pause(merchantId, regionCode, body=None, x__xgafv=None)</code>
166225
<pre>Pauses the BoG program in your Merchant Center account. Important: This method is only whitelisted for selected merchants.
167226

168227
Args:
169228
merchantId: string, Required. The ID of the account. (required)
170-
regionCode: string, 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)
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)
171230
body: object, The request body.
172231
The object takes the form of:
173232

@@ -187,7 +246,7 @@ <h3>Method Details</h3>
187246

188247
Args:
189248
merchantId: string, Required. The ID of the account. (required)
190-
regionCode: string, 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)
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)
191250
body: object, The request body.
192251
The object takes the form of:
193252

0 commit comments

Comments
 (0)