Обзор API Merchant Promotions

Используйте промоакции, чтобы продемонстрировать специальные предложения для продуктов, которые вы продаете в Google. Промоакции отображаются в различных ресурсах Google, включая Google Поиск, Покупки и Chrome.

Когда вы добавляете промоакции к своим товарам, покупатели видят ссылку на специальное предложение, например «Скидка 15 %» или «Бесплатная доставка». Ссылки на предложения могут повысить привлекательность ваших продуктов и побудить покупателей совершить покупку.

Дополнительную информацию см. в разделе Основы продвижения .

Предварительные условия

Google требует, чтобы вы предоставили конкретную информацию о своем бизнесе и продуктах, прежде чем показывать рекламные акции. У вас должно быть следующее:

Кроме того, вы должны зарегистрировать свой торговый аккаунт в программе «Акции». Если вы не уверены, зарегистрированы ли вы уже, проверьте Merchant Center .

Если вы не зарегистрированы, заполните форму запроса . Команда по продвижению сообщит вам, когда вы будете готовы начать реализацию.

Дополнительную информацию см. в разделе Критерии и правила участия .

Создать источник данных

Используйте API datasource.create для создания рекламного канала. Если существующий фид рекламной акции доступен, используйте метод accounts.dataSources.get чтобы получить имя источника данных .

Форма запроса следующая:

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/{account}/dataSources

Пример

В примере показаны типичные запрос и ответ.

Запрос:

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/123/dataSources {"displayName": "test api feed", "promotionDataSource":{"targetCountry":"US", "contentLanguage":"en"}}

Ответ:

{
  "name": "accounts/123/dataSources/1000000573361824",
  "dataSourceId": "1000000573361824",
  "displayName": "test api feed",
  "promotionDataSource": {
    "targetCountry": "US",
    "contentLanguage": "en"
  },
  "input": "API"
}

Создавайте рекламные акции

Вы можете использовать метод accounts.promotions.insert для создания или обновления рекламной акции. accounts.promotions.insert принимает в качестве входных данных ресурс promotions и имя источника данных. В случае успеха он возвращает новое или обновленное продвижение.

Для создания продвижения необходимо указать имя источника данных .

Google проверяет и одобряет ваши промоакции перед их распространением. Дополнительную информацию см. в разделе Процесс утверждения рекламной акции .

Форма запроса:

POST https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*/}promotions:insert

Для справки изучите следующие примеры рекламных акций.

Пример 1. Местная акция, применимая ко всем товарам и всем магазинам.

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions:insert

{
  "promotion": {
    "promotionId": "buy_2_get_10_off",
    "contentLanguage": "en",
    "targetCountry": "US",
    "redemptionChannel": [
      "IN_STORE"
    ],
    "attributes": {
      "longTitle": "Buy 2 and get 10$ OFF purchase",
      "productApplicability": "ALL_PRODUCTS",
      "offerType": "NO_CODE",
      "couponValueType": "BUY_M_GET_MONEY_OFF",
      "promotionDisplayTimePeriod": {
        "startTime": "2024-2-06T00:47:44Z",
        "endTime": "2024-5-06T00:47:44Z"
      },
      "promotionEffectiveTimePeriod": {
        "startTime": "2024-2-06T00:47:44Z",
        "endTime": "2024-5-06T00:47:44Z"
      },
      "moneyOffAmount": {
        "amountMicros": "1000000",
        "currencyCode": "USD"
      },
      "minimumPurchaseQuantity": 2,
      "storeApplicability": "ALL_STORES",
      "promotionUrl": "http://promotionnew4url.com/",
      "promotionDestinations": [
        "LOCAL_INVENTORY_ADS"
      ],
    }
  },
  "dataSource": "accounts/123/dataSources/1000000573361824"
}

Пример 2. Интернет-промоакция, распространяющаяся на выбранные продукты с кодом активации.

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions:insert

{
 "promotion": {
   "promotionId": "25_pct_off",
   "contentLanguage": "en",
   "targetCountry": "US",
   "redemptionChannel": [
     "ONLINE"
   ],
   "attributes": {
     "longTitle": "10% off on selected items",
     "productApplicability": "SPECIFIC_PRODUCTS",
     "offerType": "GENERIC_CODE",
     "genericRedemptionCode": "SPRINGSALE",
     "couponValueType": "PERCENT_OFF",
     "promotionDisplayTimePeriod": {
       "startTime": "2024-2-06T00:47:44Z",
       "endTime": "2024-5-06T00:47:44Z"
     },
     "promotionEffectiveTimePeriod": {
       "startTime": "2024-2-06T00:47:44Z",
       "endTime": "2024-5-06T00:47:44Z"
     },
     "percentOff": 25,
     "promotionDestinations": [
       "FREE_LISTINGS"
     ],
     "itemIdInclusion": [
       "1499860100",
       "1499860101",
       "1499860102",
       "1499860103",
       "1499860104"
     ],
   }
 },
 "dataSource": "accounts/123/dataSources/1000000573361824"
}

Особые примечания

После создания промоакции может пройти несколько минут, прежде чем она появится в базе данных Покупок.

Список атрибутов, связанных с рекламными акциями, см. в разделе Добавление атрибутов структурированных данных .

Прежде чем создавать рекламные акции и управлять ими, ознакомьтесь с рекомендациями по рекламным акциям .

Посмотреть акции

Чтобы просмотреть рекламную акцию, используйте accounts.promotions.get . Этот метод get доступен только для чтения. Для этого требуется ваш merchantId и идентификатор акции. Метод get возвращает соответствующий ресурс рекламной акции.

Например:

GET https://merchantapi.googleapis.com/promotions/v1beta/{name=accounts/*/promotions/*}

Изучите эти образцы.

Пример 1. Местная рекламная акция.

GET https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions/in_store~en~US~buy_2_get_10_off

{
 "name": "accounts/123/promotions/in_store~en~US~buy_2_get_10_off",
 "promotionId": "buy_2_get_10_off",
 "contentLanguage": "en",
 "targetCountry": "US",
 "redemptionChannel": [
   "IN_STORE"
 ],
 "attributes": {
   "longTitle": "Buy 2 and get 10$ OFF purchase",
   "productApplicability": "ALL_PRODUCTS",
   "offerType": "NO_CODE",
   "couponValueType": "BUY_M_GET_MONEY_OFF",
   "promotionDisplayTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "promotionEffectiveTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "moneyOffAmount": {
     "amountMicros": "1000000",
     "currencyCode": "USD"
   },
   "minimumPurchaseQuantity": 2,
   "storeApplicability": "ALL_STORES",
   "promotionUrl": "http://promotionnew4url.com/",
   "promotionDestinations": [
     "LOCAL_INVENTORY_ADS"
   ],
 }
 "dataSource": "accounts/123/dataSources/1000000573361824"
}

Пример 2. Интернет-продвижение

GET https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions/online~en~US~25_pct_off
{
 "name": "accounts/123/promotions/online~en~US~25_pct_off",
 "promotionId": "25_pct_off",
 "contentLanguage": "en",
 "targetCountry": "US",
 "redemptionChannel": [
   "ONLINE"
 ],
 "attributes": {
   "longTitle": "10% off on selected items",
   "productApplicability": "SPECIFIC_PRODUCTS",
   "offerType": "GENERIC_CODE",
   "genericRedemptionCode": "WINTERGIFT",
   "couponValueType": "PERCENT_OFF",
   "promotionDisplayTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "promotionEffectiveTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "percentOff": 25,
   "promotionDestinations": [
     "FREE_LISTINGS"
   ],
   "itemIdInclusion": [
     "1499860100",
     "1499860101",
     "1499860102",
     "1499860103",
     "1499860104"
   ],
 }
 "dataSource": "accounts/{account}/dataSources/{dataSource}"
}

Список рекламных акций

Вы можете использовать метод promotions.list для просмотра всех созданных промоакций.

GET https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*}/promotions

Статус акции

Чтобы просмотреть статус рекламной акции, вы можете просмотреть атрибут PromotionStatus, возвращаемый объектами promotions.get и promotions.list .

Чтобы понять процесс утверждения, см. раздел Процесс утверждения рекламной акции .

Пример статуса промоакции

Следующие примеры демонстрируют разницу между успешными и неудачными запросами.

Пример 1. В следующем тексте ответа показано онлайн-продвижение, которое было бы отклонено из-за отсутствия сопоставления продуктов.

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "REJECTED"
      }
    ],
    "itemLevelIssues": [
      {
        "code": "promotion_sku_unmapped",
        "severity": "DISAPPROVED",
        "resolution": "merchant_action",
        "reportingContext": "FREE_LISTINGS",
        "description": "Unmapped",
        "detail": "This promotion couldn't be tested during review because it doesn't apply to any products that are currently in your Products feed",
        "documentation": "https://support.google.com/merchants/answer/2906014",
        "applicableCountries": [
          "US"
        ]
      },
      {
        "code": "promotion_sku_additional_requirements",
        "severity": "DISAPPROVED",
        "resolution": "merchant_action",
        "reportingContext": "FREE_LISTINGS",
        "description": "Promotion conditions not allowed",
        "detail": "This promotion has additional requirements that are not allowed such as requiring customers to verify additional details like phone number or ID before showing the promotion details",
        "documentation": "https://support.google.com/merchants/answer/2906014",
        "applicableCountries": [
          "US"
        ]
      }
    ]
  }

Пример 2. В следующем тексте ответа показано продвижение, которое все еще находится на рассмотрении.

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "PENDING"
      },
      {
        "destination": "SHOPPING_ADS",
        "status": "PENDING"
      }
    ],
    "itemLevelIssues": []
  }

Пример 3. Утвержденная и действующая рекламная акция

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "LIVE"
      },
      {
        "destination": "SHOPPING_ADS",
        "status": "LIVE"
 }  ],
    "itemLevelIssues": []
  }

Узнать больше

Более подробную информацию можно найти в Справочном центре по рекламным акциям .

Чтобы узнать о переходе с Content API for Shopping, см. раздел «Миграция управления рекламными акциями» .

,

Используйте промоакции, чтобы продемонстрировать специальные предложения для продуктов, которые вы продаете в Google. Промоакции отображаются в различных ресурсах Google, включая Google Поиск, Покупки и Chrome.

Когда вы добавляете промоакции к своим товарам, покупатели видят ссылку на специальное предложение, например «Скидка 15 %» или «Бесплатная доставка». Ссылки на предложения могут повысить привлекательность ваших продуктов и побудить покупателей совершить покупку.

Дополнительную информацию см. в разделе Основы продвижения .

Предварительные условия

Google требует, чтобы вы предоставили конкретную информацию о своем бизнесе и продуктах, прежде чем показывать рекламные акции. У вас должно быть следующее:

Кроме того, вы должны зарегистрировать свой торговый аккаунт в программе «Акции». Если вы не уверены, зарегистрированы ли вы уже, проверьте Merchant Center .

Если вы не зарегистрированы, заполните форму запроса . Команда по продвижению сообщит вам, когда вы будете готовы начать реализацию.

Дополнительную информацию см. в разделе Критерии и правила участия .

Создать источник данных

Используйте API datasource.create для создания рекламного канала. Если существующий фид рекламной акции доступен, используйте метод accounts.dataSources.get чтобы получить имя источника данных .

Форма запроса следующая:

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/{account}/dataSources

Пример

В примере показаны типичные запрос и ответ.

Запрос:

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/123/dataSources {"displayName": "test api feed", "promotionDataSource":{"targetCountry":"US", "contentLanguage":"en"}}

Ответ:

{
  "name": "accounts/123/dataSources/1000000573361824",
  "dataSourceId": "1000000573361824",
  "displayName": "test api feed",
  "promotionDataSource": {
    "targetCountry": "US",
    "contentLanguage": "en"
  },
  "input": "API"
}

Создавайте рекламные акции

Вы можете использовать метод accounts.promotions.insert для создания или обновления рекламной акции. accounts.promotions.insert принимает в качестве входных данных ресурс promotions и имя источника данных. В случае успеха он возвращает новое или обновленное продвижение.

Для создания продвижения необходимо указать имя источника данных .

Google проверяет и одобряет ваши промоакции перед их распространением. Дополнительную информацию см. в разделе Процесс утверждения рекламной акции .

Форма запроса:

POST https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*/}promotions:insert

Для справки изучите следующие примеры рекламных акций.

Пример 1. Местная акция, применимая ко всем товарам и всем магазинам.

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions:insert

{
  "promotion": {
    "promotionId": "buy_2_get_10_off",
    "contentLanguage": "en",
    "targetCountry": "US",
    "redemptionChannel": [
      "IN_STORE"
    ],
    "attributes": {
      "longTitle": "Buy 2 and get 10$ OFF purchase",
      "productApplicability": "ALL_PRODUCTS",
      "offerType": "NO_CODE",
      "couponValueType": "BUY_M_GET_MONEY_OFF",
      "promotionDisplayTimePeriod": {
        "startTime": "2024-2-06T00:47:44Z",
        "endTime": "2024-5-06T00:47:44Z"
      },
      "promotionEffectiveTimePeriod": {
        "startTime": "2024-2-06T00:47:44Z",
        "endTime": "2024-5-06T00:47:44Z"
      },
      "moneyOffAmount": {
        "amountMicros": "1000000",
        "currencyCode": "USD"
      },
      "minimumPurchaseQuantity": 2,
      "storeApplicability": "ALL_STORES",
      "promotionUrl": "http://promotionnew4url.com/",
      "promotionDestinations": [
        "LOCAL_INVENTORY_ADS"
      ],
    }
  },
  "dataSource": "accounts/123/dataSources/1000000573361824"
}

Пример 2. Интернет-промоакция, распространяющаяся на выбранные продукты с кодом активации.

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions:insert

{
 "promotion": {
   "promotionId": "25_pct_off",
   "contentLanguage": "en",
   "targetCountry": "US",
   "redemptionChannel": [
     "ONLINE"
   ],
   "attributes": {
     "longTitle": "10% off on selected items",
     "productApplicability": "SPECIFIC_PRODUCTS",
     "offerType": "GENERIC_CODE",
     "genericRedemptionCode": "SPRINGSALE",
     "couponValueType": "PERCENT_OFF",
     "promotionDisplayTimePeriod": {
       "startTime": "2024-2-06T00:47:44Z",
       "endTime": "2024-5-06T00:47:44Z"
     },
     "promotionEffectiveTimePeriod": {
       "startTime": "2024-2-06T00:47:44Z",
       "endTime": "2024-5-06T00:47:44Z"
     },
     "percentOff": 25,
     "promotionDestinations": [
       "FREE_LISTINGS"
     ],
     "itemIdInclusion": [
       "1499860100",
       "1499860101",
       "1499860102",
       "1499860103",
       "1499860104"
     ],
   }
 },
 "dataSource": "accounts/123/dataSources/1000000573361824"
}

Особые примечания

После создания промоакции может пройти несколько минут, прежде чем она появится в базе данных Покупок.

Список атрибутов, связанных с рекламными акциями, см. в разделе Добавление атрибутов структурированных данных .

Прежде чем создавать рекламные акции и управлять ими, ознакомьтесь с рекомендациями по рекламным акциям .

Посмотреть акции

Чтобы просмотреть рекламную акцию, используйте accounts.promotions.get . Этот метод get доступен только для чтения. Для этого требуется ваш merchantId и идентификатор акции. Метод get возвращает соответствующий ресурс рекламной акции.

Например:

GET https://merchantapi.googleapis.com/promotions/v1beta/{name=accounts/*/promotions/*}

Изучите эти образцы.

Пример 1. Местная рекламная акция.

GET https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions/in_store~en~US~buy_2_get_10_off

{
 "name": "accounts/123/promotions/in_store~en~US~buy_2_get_10_off",
 "promotionId": "buy_2_get_10_off",
 "contentLanguage": "en",
 "targetCountry": "US",
 "redemptionChannel": [
   "IN_STORE"
 ],
 "attributes": {
   "longTitle": "Buy 2 and get 10$ OFF purchase",
   "productApplicability": "ALL_PRODUCTS",
   "offerType": "NO_CODE",
   "couponValueType": "BUY_M_GET_MONEY_OFF",
   "promotionDisplayTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "promotionEffectiveTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "moneyOffAmount": {
     "amountMicros": "1000000",
     "currencyCode": "USD"
   },
   "minimumPurchaseQuantity": 2,
   "storeApplicability": "ALL_STORES",
   "promotionUrl": "http://promotionnew4url.com/",
   "promotionDestinations": [
     "LOCAL_INVENTORY_ADS"
   ],
 }
 "dataSource": "accounts/123/dataSources/1000000573361824"
}

Пример 2. Интернет-продвижение

GET https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions/online~en~US~25_pct_off
{
 "name": "accounts/123/promotions/online~en~US~25_pct_off",
 "promotionId": "25_pct_off",
 "contentLanguage": "en",
 "targetCountry": "US",
 "redemptionChannel": [
   "ONLINE"
 ],
 "attributes": {
   "longTitle": "10% off on selected items",
   "productApplicability": "SPECIFIC_PRODUCTS",
   "offerType": "GENERIC_CODE",
   "genericRedemptionCode": "WINTERGIFT",
   "couponValueType": "PERCENT_OFF",
   "promotionDisplayTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "promotionEffectiveTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "percentOff": 25,
   "promotionDestinations": [
     "FREE_LISTINGS"
   ],
   "itemIdInclusion": [
     "1499860100",
     "1499860101",
     "1499860102",
     "1499860103",
     "1499860104"
   ],
 }
 "dataSource": "accounts/{account}/dataSources/{dataSource}"
}

Список рекламных акций

Вы можете использовать метод promotions.list для просмотра всех созданных промоакций.

GET https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*}/promotions

Статус акции

Чтобы просмотреть статус рекламной акции, вы можете просмотреть атрибут PromotionStatus, возвращаемый объектами promotions.get и promotions.list .

Чтобы понять процесс утверждения, см. раздел Процесс утверждения рекламной акции .

Пример статуса промоакции

Следующие примеры демонстрируют разницу между успешными и неудачными запросами.

Пример 1. В следующем тексте ответа показано онлайн-продвижение, которое было бы отклонено из-за отсутствия сопоставления продуктов.

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "REJECTED"
      }
    ],
    "itemLevelIssues": [
      {
        "code": "promotion_sku_unmapped",
        "severity": "DISAPPROVED",
        "resolution": "merchant_action",
        "reportingContext": "FREE_LISTINGS",
        "description": "Unmapped",
        "detail": "This promotion couldn't be tested during review because it doesn't apply to any products that are currently in your Products feed",
        "documentation": "https://support.google.com/merchants/answer/2906014",
        "applicableCountries": [
          "US"
        ]
      },
      {
        "code": "promotion_sku_additional_requirements",
        "severity": "DISAPPROVED",
        "resolution": "merchant_action",
        "reportingContext": "FREE_LISTINGS",
        "description": "Promotion conditions not allowed",
        "detail": "This promotion has additional requirements that are not allowed such as requiring customers to verify additional details like phone number or ID before showing the promotion details",
        "documentation": "https://support.google.com/merchants/answer/2906014",
        "applicableCountries": [
          "US"
        ]
      }
    ]
  }

Пример 2. В следующем тексте ответа показано продвижение, которое все еще находится на рассмотрении.

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "PENDING"
      },
      {
        "destination": "SHOPPING_ADS",
        "status": "PENDING"
      }
    ],
    "itemLevelIssues": []
  }

Пример 3. Утвержденная и действующая рекламная акция

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "LIVE"
      },
      {
        "destination": "SHOPPING_ADS",
        "status": "LIVE"
 }  ],
    "itemLevelIssues": []
  }

Узнать больше

Более подробную информацию можно найти в Справочном центре по рекламным акциям .

Чтобы узнать о переходе с Content API for Shopping, см. раздел «Миграция управления рекламными акциями» .