Skip to content

Commit fdd69d7

Browse files
feat(merchantapi): update the api
#### merchantapi:products_v1beta The following keys were added: - schemas.LoyaltyProgram.properties.shippingLabel.type (Total Keys: 1)
1 parent 6069673 commit fdd69d7

16 files changed

+94
-86
lines changed

docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

docs/dyn/merchantapi_accounts_v1beta.accounts.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,8 @@ <h3>Method Details</h3>
184184
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
185185
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
186186
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
187-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
188-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
187+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
188+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
189189
},
190190
},
191191
&quot;service&quot;: [ # Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation`, which means you can only create sub accounts, not standalone account through this method. Additional `account_management` or `product_management` services may be provided.
@@ -226,8 +226,8 @@ <h3>Method Details</h3>
226226
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
227227
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
228228
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
229-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
230-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
229+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
230+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
231231
},
232232
}</pre>
233233
</div>
@@ -273,8 +273,8 @@ <h3>Method Details</h3>
273273
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
274274
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
275275
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
276-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
277-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
276+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
277+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
278278
},
279279
}</pre>
280280
</div>
@@ -305,8 +305,8 @@ <h3>Method Details</h3>
305305
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
306306
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
307307
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
308-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
309-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
308+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
309+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
310310
},
311311
},
312312
],
@@ -340,8 +340,8 @@ <h3>Method Details</h3>
340340
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
341341
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
342342
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
343-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
344-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
343+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
344+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
345345
},
346346
},
347347
],
@@ -394,8 +394,8 @@ <h3>Method Details</h3>
394394
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
395395
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
396396
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
397-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
398-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
397+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
398+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
399399
},
400400
}
401401

@@ -416,8 +416,8 @@ <h3>Method Details</h3>
416416
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account. Format: `accounts/{account}`
417417
&quot;testAccount&quot;: True or False, # Output only. Whether this is a test account.
418418
&quot;timeZone&quot;: { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The time zone of the account. On writes, `time_zone` sets both the `reporting_time_zone` and the `display_time_zone`. For reads, `time_zone` always returns the `display_time_zone`. If `display_time_zone` doesn&#x27;t exist for your account, `time_zone` is empty.
419-
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
420-
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
419+
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
420+
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
421421
},
422422
}</pre>
423423
</div>

docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ <h3>Method Details</h3>
192192
&quot;A String&quot;,
193193
],
194194
&quot;carrierRates&quot;: [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
195-
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?hl=en&amp;ref_topic=12570808&amp;sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
195+
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&amp;sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
196196
&quot;carrier&quot;: &quot;A String&quot;, # Required. Carrier service, such as `&quot;UPS&quot;` or `&quot;Fedex&quot;`.
197197
&quot;carrierService&quot;: &quot;A String&quot;, # Required. Carrier service, such as `&quot;ground&quot;` or `&quot;2 days&quot;`.
198198
&quot;flatAdjustment&quot;: { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ &quot;amount_micros&quot;: 1, &quot;currency_code&quot; : &quot;USD&quot; }` adds $1 to the rate, `{ &quot;amount_micros&quot;: -3, &quot;currency_code&quot; : &quot;USD&quot; }` removes $3 from the rate.
@@ -510,7 +510,7 @@ <h3>Method Details</h3>
510510
&quot;A String&quot;,
511511
],
512512
&quot;carrierRates&quot;: [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
513-
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?hl=en&amp;ref_topic=12570808&amp;sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
513+
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&amp;sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
514514
&quot;carrier&quot;: &quot;A String&quot;, # Required. Carrier service, such as `&quot;UPS&quot;` or `&quot;Fedex&quot;`.
515515
&quot;carrierService&quot;: &quot;A String&quot;, # Required. Carrier service, such as `&quot;ground&quot;` or `&quot;2 days&quot;`.
516516
&quot;flatAdjustment&quot;: { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ &quot;amount_micros&quot;: 1, &quot;currency_code&quot; : &quot;USD&quot; }` adds $1 to the rate, `{ &quot;amount_micros&quot;: -3, &quot;currency_code&quot; : &quot;USD&quot; }` removes $3 from the rate.
@@ -826,7 +826,7 @@ <h3>Method Details</h3>
826826
&quot;A String&quot;,
827827
],
828828
&quot;carrierRates&quot;: [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
829-
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?hl=en&amp;ref_topic=12570808&amp;sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
829+
{ # A list of carrier rates that can be referred to by `main_table` or `single_value`. Supported carrier services are defined in https://support.google.com/merchants/answer/12577710?ref_topic=12570808&amp;sjid=10662598224319463032-NC#zippy=%2Cdelivery-cost-rate-type%2Ccarrier-rate-au-de-uk-and-us-only.
830830
&quot;carrier&quot;: &quot;A String&quot;, # Required. Carrier service, such as `&quot;UPS&quot;` or `&quot;Fedex&quot;`.
831831
&quot;carrierService&quot;: &quot;A String&quot;, # Required. Carrier service, such as `&quot;ground&quot;` or `&quot;2 days&quot;`.
832832
&quot;flatAdjustment&quot;: { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ &quot;amount_micros&quot;: 1, &quot;currency_code&quot; : &quot;USD&quot; }` adds $1 to the rate, `{ &quot;amount_micros&quot;: -3, &quot;currency_code&quot; : &quot;USD&quot; }` removes $3 from the rate.

docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3>Method Details</h3>
117117
body: object, The request body.
118118
The object takes the form of:
119119

120-
{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).
120+
{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).
121121
&quot;attributes&quot;: { # Attributes. # Optional. A list of product attributes.
122122
&quot;additionalImageLinks&quot;: [ # Additional URLs of images of the item.
123123
&quot;A String&quot;,
@@ -248,6 +248,7 @@ <h3>Method Details</h3>
248248
&quot;currencyCode&quot;: &quot;A String&quot;, # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
249249
},
250250
&quot;programLabel&quot;: &quot;A String&quot;, # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
251+
&quot;shippingLabel&quot;: &quot;A String&quot;, # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn&#x27;t provided, the item is not eligible for loyalty shipping for the given loyalty tier.
251252
&quot;tierLabel&quot;: &quot;A String&quot;, # The label of the tier within the loyalty program. Must match one of the labels within the program.
252253
},
253254
],
@@ -418,7 +419,7 @@ <h3>Method Details</h3>
418419
Returns:
419420
An object of the form:
420421

421-
{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).
422+
{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the vertical spec with [some exceptions](https://support.google.com/merchants/answer/7052112).
422423
&quot;attributes&quot;: { # Attributes. # Optional. A list of product attributes.
423424
&quot;additionalImageLinks&quot;: [ # Additional URLs of images of the item.
424425
&quot;A String&quot;,
@@ -549,6 +550,7 @@ <h3>Method Details</h3>
549550
&quot;currencyCode&quot;: &quot;A String&quot;, # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
550551
},
551552
&quot;programLabel&quot;: &quot;A String&quot;, # The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.
553+
&quot;shippingLabel&quot;: &quot;A String&quot;, # The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn&#x27;t provided, the item is not eligible for loyalty shipping for the given loyalty tier.
552554
&quot;tierLabel&quot;: &quot;A String&quot;, # The label of the tier within the loyalty program. Must match one of the labels within the program.
553555
},
554556
],

0 commit comments

Comments
 (0)