Skip to content

Commit

Permalink
feat(content): update the API
Browse files Browse the repository at this point in the history
#### content:v2.1

The following keys were added:
- schemas.Product.properties.lifestyleImageLinks.description
- schemas.Product.properties.lifestyleImageLinks.items.type
- schemas.Product.properties.lifestyleImageLinks.type
- schemas.Promotion.properties.promotionStatus.$ref
- schemas.Promotion.properties.promotionStatus.description
- schemas.Promotion.properties.promotionStatus.readOnly
- schemas.PromotionPromotionStatus.description
- schemas.PromotionPromotionStatus.id
- schemas.PromotionPromotionStatus.properties.creationDate.description
- schemas.PromotionPromotionStatus.properties.creationDate.type
- schemas.PromotionPromotionStatus.properties.destinationStatuses.description
- schemas.PromotionPromotionStatus.properties.destinationStatuses.items.$ref
- schemas.PromotionPromotionStatus.properties.destinationStatuses.type
- schemas.PromotionPromotionStatus.properties.lastUpdateDate.description
- schemas.PromotionPromotionStatus.properties.lastUpdateDate.type
- schemas.PromotionPromotionStatus.properties.promotionIssue.description
- schemas.PromotionPromotionStatus.properties.promotionIssue.items.$ref
- schemas.PromotionPromotionStatus.properties.promotionIssue.type
- schemas.PromotionPromotionStatus.type
- schemas.PromotionPromotionStatusDestinationStatus.description
- schemas.PromotionPromotionStatusDestinationStatus.id
- schemas.PromotionPromotionStatusDestinationStatus.properties.destination.description
- schemas.PromotionPromotionStatusDestinationStatus.properties.destination.type
- schemas.PromotionPromotionStatusDestinationStatus.properties.status.description
- schemas.PromotionPromotionStatusDestinationStatus.properties.status.enum
- schemas.PromotionPromotionStatusDestinationStatus.properties.status.enumDescriptions
- schemas.PromotionPromotionStatusDestinationStatus.properties.status.type
- schemas.PromotionPromotionStatusDestinationStatus.type
- schemas.PromotionPromotionStatusPromotionIssue.description
- schemas.PromotionPromotionStatusPromotionIssue.id
- schemas.PromotionPromotionStatusPromotionIssue.properties.code.description
- schemas.PromotionPromotionStatusPromotionIssue.properties.code.type
- schemas.PromotionPromotionStatusPromotionIssue.properties.detail.description
- schemas.PromotionPromotionStatusPromotionIssue.properties.detail.type
- schemas.PromotionPromotionStatusPromotionIssue.type

The following keys were changed:
- schemas.Account.properties.adsLinks.description
- schemas.Product.description
- schemas.Product.properties.productTypes.description
- schemas.Product.properties.salePriceEffectiveDate.description
- schemas.ProductShipping.properties.locationId.description
- schemas.ProductTax.properties.locationId.description
- schemas.RepricingRule.description
  • Loading branch information
yoshi-automation authored and sofisl committed Feb 2, 2023
1 parent 43992e0 commit 8cf1e31
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 15 deletions.
105 changes: 97 additions & 8 deletions discovery/content-v2.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -5953,7 +5953,7 @@
}
}
},
"revision": "20221213",
"revision": "20230123",
"rootUrl": "https://shoppingcontent.googleapis.com/",
"schemas": {
"Account": {
Expand All @@ -5966,7 +5966,7 @@
"type": "string"
},
"adsLinks": {
"description": "Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.",
"description": "Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.",
"items": {
"$ref": "AccountAdsLink"
},
Expand Down Expand Up @@ -12738,7 +12738,7 @@
"type": "object"
},
"Product": {
"description": " Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.",
"description": " Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.",
"id": "Product",
"properties": {
"additionalImageLinks": {
Expand Down Expand Up @@ -12936,6 +12936,13 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"",
"type": "string"
},
"lifestyleImageLinks": {
"description": "Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.",
"items": {
"type": "string"
},
"type": "array"
},
"link": {
"description": "URL directly linking to your item's page on your website.",
"type": "string"
Expand Down Expand Up @@ -13034,7 +13041,7 @@
"description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
},
"productTypes": {
"description": "Categories of the item (formatted as in products data specification).",
"description": "Categories of the item (formatted as in product data specification).",
"items": {
"type": "string"
},
Expand All @@ -13060,7 +13067,7 @@
"description": "Advertised sale price of the item."
},
"salePriceEffectiveDate": {
"description": "Date range during which the item is on sale (see products data specification ).",
"description": "Date range during which the item is on sale (see product data specification ).",
"type": "string"
},
"sellOnGoogleQuantity": {
Expand Down Expand Up @@ -13367,7 +13374,7 @@
"type": "string"
},
"locationId": {
"description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.",
"description": "The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.",
"format": "int64",
"type": "string"
},
Expand Down Expand Up @@ -13596,7 +13603,7 @@
"type": "string"
},
"locationId": {
"description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
"description": "The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.",
"format": "int64",
"type": "string"
},
Expand Down Expand Up @@ -14349,6 +14356,11 @@
"description": "Required. The user provided promotion ID to uniquely identify the promotion.",
"type": "string"
},
"promotionStatus": {
"$ref": "PromotionPromotionStatus",
"description": "Output only. The current status of the promotion.",
"readOnly": true
},
"promotionUrl": {
"description": "URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.",
"type": "string"
Expand Down Expand Up @@ -14412,6 +14424,83 @@
},
"type": "object"
},
"PromotionPromotionStatus": {
"description": "The status of the promotion.",
"id": "PromotionPromotionStatus",
"properties": {
"creationDate": {
"description": "Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
"type": "string"
},
"destinationStatuses": {
"description": "The intended destinations for the promotion.",
"items": {
"$ref": "PromotionPromotionStatusDestinationStatus"
},
"type": "array"
},
"lastUpdateDate": {
"description": "Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
"type": "string"
},
"promotionIssue": {
"description": "A list of issues associated with the promotion.",
"items": {
"$ref": "PromotionPromotionStatusPromotionIssue"
},
"type": "array"
}
},
"type": "object"
},
"PromotionPromotionStatusDestinationStatus": {
"description": "The destination status of the promotion.",
"id": "PromotionPromotionStatusDestinationStatus",
"properties": {
"destination": {
"description": "The name of the destination.",
"type": "string"
},
"status": {
"description": "The status for the specified destination.",
"enum": [
"STATE_UNSPECIFIED",
"IN_REVIEW",
"REJECTED",
"LIVE",
"STOPPED",
"EXPIRED",
"PENDING"
],
"enumDescriptions": [
"Unknown promotion state.",
"The promotion is under review.",
"The promotion is disapproved",
"The promotion is approved and active.",
"The promotion is stopped by merchant.",
"The promotion is no longer active.",
"The promotion is not stopped, and all reviews are approved, but the active date is in the future."
],
"type": "string"
}
},
"type": "object"
},
"PromotionPromotionStatusPromotionIssue": {
"description": "The issue associated with the promotion.",
"id": "PromotionPromotionStatusPromotionIssue",
"properties": {
"code": {
"description": "Code of the issue.",
"type": "string"
},
"detail": {
"description": "Explanation of the issue.",
"type": "string"
}
},
"type": "object"
},
"PubsubNotificationSettings": {
"description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.",
"id": "PubsubNotificationSettings",
Expand Down Expand Up @@ -14817,7 +14906,7 @@
"type": "object"
},
"RepricingRule": {
"description": "Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24",
"description": "Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.",
"id": "RepricingRule",
"properties": {
"cogsBasedRule": {
Expand Down
77 changes: 70 additions & 7 deletions src/apis/content/v2.1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ export namespace content_v2_1 {
*/
accountManagement?: string | null;
/**
* Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
* Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.
*/
adsLinks?: Schema$AccountAdsLink[];
/**
Expand Down Expand Up @@ -5224,7 +5224,7 @@ export namespace content_v2_1 {
suggestedPriceMicros?: string | null;
}
/**
* Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
* Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
*/
export interface Schema$Product {
/**
Expand Down Expand Up @@ -5403,6 +5403,10 @@ export namespace content_v2_1 {
* Identifies what kind of resource this is. Value: the fixed string "`content#product`"
*/
kind?: string | null;
/**
* Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
*/
lifestyleImageLinks?: string[] | null;
/**
* URL directly linking to your item's page on your website.
*/
Expand Down Expand Up @@ -5492,7 +5496,7 @@ export namespace content_v2_1 {
*/
productLength?: Schema$ProductDimension;
/**
* Categories of the item (formatted as in products data specification).
* Categories of the item (formatted as in product data specification).
*/
productTypes?: string[] | null;
/**
Expand All @@ -5512,7 +5516,7 @@ export namespace content_v2_1 {
*/
salePrice?: Schema$Price;
/**
* Date range during which the item is on sale (see products data specification ).
* Date range during which the item is on sale (see product data specification ).
*/
salePriceEffectiveDate?: string | null;
/**
Expand Down Expand Up @@ -5815,7 +5819,7 @@ export namespace content_v2_1 {
*/
locationGroupName?: string | null;
/**
* The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
* The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.
*/
locationId?: string | null;
/**
Expand Down Expand Up @@ -6080,7 +6084,7 @@ export namespace content_v2_1 {
*/
country?: string | null;
/**
* The numeric ID of a location that the tax rate applies to as defined in the AdWords API.
* The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.
*/
locationId?: string | null;
/**
Expand Down Expand Up @@ -6435,6 +6439,10 @@ export namespace content_v2_1 {
* Required. The user provided promotion ID to uniquely identify the promotion.
*/
promotionId?: string | null;
/**
* Output only. The current status of the promotion.
*/
promotionStatus?: Schema$PromotionPromotionStatus;
/**
* URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.
*/
Expand Down Expand Up @@ -6464,6 +6472,53 @@ export namespace content_v2_1 {
*/
targetCountry?: string | null;
}
/**
* The status of the promotion.
*/
export interface Schema$PromotionPromotionStatus {
/**
* Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
*/
creationDate?: string | null;
/**
* The intended destinations for the promotion.
*/
destinationStatuses?: Schema$PromotionPromotionStatusDestinationStatus[];
/**
* Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z"
*/
lastUpdateDate?: string | null;
/**
* A list of issues associated with the promotion.
*/
promotionIssue?: Schema$PromotionPromotionStatusPromotionIssue[];
}
/**
* The destination status of the promotion.
*/
export interface Schema$PromotionPromotionStatusDestinationStatus {
/**
* The name of the destination.
*/
destination?: string | null;
/**
* The status for the specified destination.
*/
status?: string | null;
}
/**
* The issue associated with the promotion.
*/
export interface Schema$PromotionPromotionStatusPromotionIssue {
/**
* Code of the issue.
*/
code?: string | null;
/**
* Explanation of the issue.
*/
detail?: string | null;
}
/**
* Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.
*/
Expand Down Expand Up @@ -6772,7 +6827,7 @@ export namespace content_v2_1 {
buyboxWinsCount?: number | null;
}
/**
* Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24
* Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
*/
export interface Schema$RepricingRule {
/**
Expand Down Expand Up @@ -26662,6 +26717,7 @@ export namespace content_v2_1 {
* // "isBundle": false,
* // "itemGroupId": "my_itemGroupId",
* // "kind": "my_kind",
* // "lifestyleImageLinks": [],
* // "link": "my_link",
* // "linkTemplate": "my_linkTemplate",
* // "loyaltyPoints": {},
Expand Down Expand Up @@ -26883,6 +26939,7 @@ export namespace content_v2_1 {
* // "isBundle": false,
* // "itemGroupId": "my_itemGroupId",
* // "kind": "my_kind",
* // "lifestyleImageLinks": [],
* // "link": "my_link",
* // "linkTemplate": "my_linkTemplate",
* // "loyaltyPoints": {},
Expand Down Expand Up @@ -26982,6 +27039,7 @@ export namespace content_v2_1 {
* // "isBundle": false,
* // "itemGroupId": "my_itemGroupId",
* // "kind": "my_kind",
* // "lifestyleImageLinks": [],
* // "link": "my_link",
* // "linkTemplate": "my_linkTemplate",
* // "loyaltyPoints": {},
Expand Down Expand Up @@ -27346,6 +27404,7 @@ export namespace content_v2_1 {
* // "isBundle": false,
* // "itemGroupId": "my_itemGroupId",
* // "kind": "my_kind",
* // "lifestyleImageLinks": [],
* // "link": "my_link",
* // "linkTemplate": "my_linkTemplate",
* // "loyaltyPoints": {},
Expand Down Expand Up @@ -27445,6 +27504,7 @@ export namespace content_v2_1 {
* // "isBundle": false,
* // "itemGroupId": "my_itemGroupId",
* // "kind": "my_kind",
* // "lifestyleImageLinks": [],
* // "link": "my_link",
* // "linkTemplate": "my_linkTemplate",
* // "loyaltyPoints": {},
Expand Down Expand Up @@ -28414,6 +28474,7 @@ export namespace content_v2_1 {
* // "promotionEffectiveDates": "my_promotionEffectiveDates",
* // "promotionEffectiveTimePeriod": {},
* // "promotionId": "my_promotionId",
* // "promotionStatus": {},
* // "promotionUrl": "my_promotionUrl",
* // "redemptionChannel": [],
* // "shippingServiceNames": [],
Expand Down Expand Up @@ -28461,6 +28522,7 @@ export namespace content_v2_1 {
* // "promotionEffectiveDates": "my_promotionEffectiveDates",
* // "promotionEffectiveTimePeriod": {},
* // "promotionId": "my_promotionId",
* // "promotionStatus": {},
* // "promotionUrl": "my_promotionUrl",
* // "redemptionChannel": [],
* // "shippingServiceNames": [],
Expand Down Expand Up @@ -28632,6 +28694,7 @@ export namespace content_v2_1 {
* // "promotionEffectiveDates": "my_promotionEffectiveDates",
* // "promotionEffectiveTimePeriod": {},
* // "promotionId": "my_promotionId",
* // "promotionStatus": {},
* // "promotionUrl": "my_promotionUrl",
* // "redemptionChannel": [],
* // "shippingServiceNames": [],
Expand Down

0 comments on commit 8cf1e31

Please sign in to comment.