Перенос управления учетными записями из Content API for Shopping

В этом документе объясняется, как перейти с Content API версии 2.1 на Merchant API.

Обзор изменений с Content API v2.1 на Merchant API

Merchant API представляет собой значительные улучшения по сравнению с Content API v2.1, направленные на повышение удобства использования, согласованности и гибкости для разработчиков и предприятий.

Детализированная структура ресурсов

Ресурсы в Merchant API представляют собой отдельные понятия, такие как account , businessDetails , user , homepage и program . Они организованы иерархически, чтобы отразить их отношения. Например, account является родительским ресурсом для user .

Единые сервисы учетных записей

Все службы учетных записей (например, агрегирование учетных записей для MCA и их субсчетов или между сторонними поставщиками услуг и учетными записями) управляются через единый ресурс accountService . Поставщики услуг могут управлять своими отношениями с помощью ресурса accountRelationship .

Упрощенная структура URL

URL-адреса теперь используют один идентификатор учетной записи (например, merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId} ) вместо нескольких идентификаторов. Пути URL-адресов отражают детальную структуру ресурсов.

Другие улучшения

  • Улучшенное управление программами и пользователями . Такие программы, как товарная реклама и бесплатные объявления, объединены в один program ресурс. user ресурс включает в себя комплексные возможности управления с детальными правами доступа.
  • Структурированная бизнес-информация и бизнес-идентификация . Существуют специальные ресурсы для businessInfo и businessIdentity . Они включают поддержку соответствия требованиям с полями для данных, специфичных для региона. Например, регистрационный номер корейской компании.
  • Упрощенное утверждение претензий на главной странице : выделенный ресурс homepage управляет URL-адресом домашней страницы магазина. Такие методы, как claim и unclaim обрабатывают заявки на веб-сайты непосредственно через API.
  • Соответствие рекомендациям Google API . Merchant API стремится соответствовать предложениям Google по улучшению API .

Миграция управления аккаунтами

Вы можете использовать ресурс accounts для создания и управления своей учетной записью продавца. Дополнительную информацию см. в разделе Обзор API учетных записей продавцов .

На этой странице описано, как перенести управление учетными записями из Content API в Merchant API.

Запросы

Используйте следующий формат URL-адреса запроса для API учетных записей торговцев:

POST https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts

Ниже приведен пример сравнения Content API для покупок с API учетных записей продавцов для запросов на создание и управление учетными записями:

API контента для покупок API торговых счетов
URL-адрес https://shoppingcontent.googleapis.com/content/v2.1/ MerchantId /accounts/ accountId / https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId
Идентификаторы идентификатор продавца /accounts/ идентификатор аккаунта accounts/ идентификатор аккаунта

Ресурсы

Данные учетной записи передаются с использованием ресурса Account в Content API for Shopping. API учетных записей торговцев предоставляет несколько ресурсов для передачи данных учетных записей. Эти ресурсы включают ресурсы Account , User , BusinessInfo и BusinessIdentity .

В следующей таблице представлено сравнение ресурса Account в Content API для покупок и ресурса Account в API учетных записей продавцов.

API контента для покупок API торговых счетов
id name
name accountName
kind Нет в наличии
websiteUrl Поле uri в ресурсе Homepage
adultContent adultContent
sellerId Поле accountIdAlias ​​в ресурсе AccountRelationship .
users В ресурсе [User](/merchant/api/reference/rest/v1/accounts.v1beta.accounts.users)
youtubeChannelLinks Пока недоступно
googleMyBusinessLink Пока недоступно
businessInformation В ресурсе [businessInfo](/merchant/api/reference/rest/v1/BusinessInfo)
businessIdentity В ресурсе [businessIdentity](/merchant/api/reference/rest/v1/BusinessIdentity)
automaticImprovements Пока недоступно
adsLinks Поле campaignsManagement в ресурсе AccountService
cssId Доступно только в CSS API.
labelIds Доступно только в CSS API.
accountManagement Поле accountManagement в ресурсе AccountService
automaticLabelIds Доступно только в CSS API.
conversionSettings Пока недоступно

В следующей таблице представлено сравнение ресурса AccountUser в Content API для покупок и ресурса User в API учетных записей продавцов.

API контента для покупок API торговых счетов
emailAddress электронная почта является частью name ( accounts/{account}/users/{email} ).
admin user#accessRights.ADMIN
orderManager Нет в наличии
paymentsManager Нет в наличии
paymentsAnalyst Нет в наличии
reportingManager user#accessRights.PERFORMANCE_REPORTING

В следующей таблице представлено сравнение ресурса AccountBusinessInformation в Content API for Shopping и его эквивалентного ресурса businessInfo в API Merchant Accounts API.

API контента для покупок API торговых счетов
businessInformation businessInfo
phoneNumber phone
phoneVerificationStatus phoneVerificationState
customerService customerService
koreanBusinessRegistrationNumber koreanBusinessRegistrationNumber

В следующей таблице представлено сравнение ресурса AccountBusinessIdentity в Content API для покупок и ресурса businessIdentity в API учетных записей продавцов.

API контента для покупок API торговых счетов
blackOwned blackOwned
womenOwned womenOwned
veteranOwned veteranOwned
latinoOwned latinoOwned
smallBusiness smallBusiness
includeForPromotions promotionsConsent
- true означает PROMOTION_CONSENT_GIVEN
- false означает PROMOTION_CONSENT_DENIED

Ресурс AccountIdentityType в Content API представлен типом IdentityAttribute и его identityDeclaration в MerchantAPI.

API контента для покупок API торговых счетов
self_identified identityDeclaration
- true означает SELF_IDENTIFIES_AS
- false означает DOES_NOT_SELF_IDENTIFY_AS

Методы

В API торговых счетов были введены следующие методы:

API контента для покупок API торговых счетов
accounts.authinfo GET https://merchantapi.googleapis.com/accounts/v1beta/accounts без фильтра
accounts.claimwebsite POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/ / homepage /homepage:claim
Дополнительную информацию см. в разделе Метод: account.v1beta.accounts.homepage.claim.
accounts.custombatch Нет в наличии. Специальная партия не поддерживается в Merchant API.
accounts.delete DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId
accounts.get GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId `
accounts.insert POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure
Дополнительную информацию см. в разделе Создание и настройка учетной записи продавца.
accounts.link Ресурс AccountService
accounts.list GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId :listSubaccounts
accounts.listlinks GET https://merchantapi.googleapis.com/accounts/v1beta/ https://merchantapi.googleapis.com/accounts/v1beta/accountId/services /services
accounts.update Сопоставляется с запросом на обновление ресурса, в котором определено необходимое поле или набор полей.
,

В этом документе объясняется, как перейти с Content API версии 2.1 на Merchant API.

Обзор изменений с Content API v2.1 на Merchant API

Merchant API представляет собой значительные улучшения по сравнению с Content API v2.1, направленные на повышение удобства использования, согласованности и гибкости для разработчиков и предприятий.

Детализированная структура ресурсов

Ресурсы в Merchant API представляют собой отдельные понятия, такие как account , businessDetails , user , homepage и program . Они организованы иерархически, чтобы отразить их отношения. Например, account является родительским ресурсом для user .

Единые сервисы учетных записей

Все службы учетных записей (например, агрегирование учетных записей для MCA и их субсчетов или между сторонними поставщиками услуг и учетными записями) управляются через единый ресурс accountService . Поставщики услуг могут управлять своими отношениями с помощью ресурса accountRelationship .

Упрощенная структура URL

URL-адреса теперь используют один идентификатор учетной записи (например, merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId} ) вместо нескольких идентификаторов. URL-пути отражают детальную структуру ресурсов.

Другие улучшения

  • Улучшенное управление программами и пользователями . Такие программы, как товарная реклама и бесплатные объявления, объединены в единый program ресурс. user ресурс включает в себя комплексные возможности управления с детальными правами доступа.
  • Структурированная бизнес-информация и бизнес-идентификация . Существуют специальные ресурсы для businessInfo и businessIdentity . Они включают поддержку соответствия требованиям с полями для данных, специфичных для региона. Например, регистрационный номер корейской компании.
  • Упрощенное утверждение претензий на главной странице : выделенный ресурс homepage управляет URL-адресом домашней страницы магазина. Такие методы, как claim и unclaim обрабатывают заявки на веб-сайты непосредственно через API.
  • Соответствие рекомендациям Google API . Merchant API стремится соответствовать предложениям Google по улучшению API .

Миграция управления аккаунтами

Вы можете использовать ресурс accounts для создания и управления своей учетной записью продавца. Дополнительную информацию см. в разделе Обзор API учетных записей продавцов .

На этой странице описано, как перенести управление учетными записями из Content API в Merchant API.

Запросы

Используйте следующий формат URL-адреса запроса для API учетных записей торговцев:

POST https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts

Ниже приведен пример сравнения Content API для покупок с API учетных записей продавцов для запросов на создание и управление учетными записями:

API контента для покупок API торговых счетов
URL-адрес https://shoppingcontent.googleapis.com/content/v2.1/ MerchantId /accounts/ accountId / https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId
Идентификаторы идентификатор продавца /accounts/ идентификатор аккаунта accounts/ идентификатор аккаунта

Ресурсы

Данные учетной записи передаются с использованием ресурса Account в Content API for Shopping. API учетных записей торговцев предоставляет несколько ресурсов для передачи данных учетных записей. Эти ресурсы включают ресурсы Account , User , BusinessInfo и BusinessIdentity .

В следующей таблице представлено сравнение ресурса Account в Content API для покупок и ресурса Account в API учетных записей продавцов.

API контента для покупок API торговых счетов
id name
name accountName
kind Нет в наличии
websiteUrl Поле uri в ресурсе Homepage
adultContent adultContent
sellerId Поле accountIdAlias ​​в ресурсе AccountRelationship .
users В ресурсе [User](/merchant/api/reference/rest/v1/accounts.v1beta.accounts.users)
youtubeChannelLinks Пока недоступно
googleMyBusinessLink Пока недоступно
businessInformation В ресурсе [businessInfo](/merchant/api/reference/rest/v1/BusinessInfo)
businessIdentity В ресурсе [businessIdentity](/merchant/api/reference/rest/v1/BusinessIdentity)
automaticImprovements Пока недоступно
adsLinks Поле campaignsManagement в ресурсе AccountService
cssId Доступно только в CSS API.
labelIds Доступно только в CSS API.
accountManagement Поле accountManagement в ресурсе AccountService
automaticLabelIds Доступно только в CSS API.
conversionSettings Пока недоступно

В следующей таблице представлено сравнение ресурса AccountUser в Content API для покупок и ресурса User в API учетных записей продавцов.

API контента для покупок API торговых счетов
emailAddress электронная почта является частью name ( accounts/{account}/users/{email} ).
admin user#accessRights.ADMIN
orderManager Нет в наличии
paymentsManager Нет в наличии
paymentsAnalyst Нет в наличии
reportingManager user#accessRights.PERFORMANCE_REPORTING

В следующей таблице представлено сравнение ресурса AccountBusinessInformation в Content API for Shopping и его эквивалентного ресурса businessInfo в API Merchant Accounts API.

API контента для покупок API торговых счетов
businessInformation businessInfo
phoneNumber phone
phoneVerificationStatus phoneVerificationState
customerService customerService
koreanBusinessRegistrationNumber koreanBusinessRegistrationNumber

В следующей таблице представлено сравнение ресурса AccountBusinessIdentity в Content API для покупок и ресурса businessIdentity в API учетных записей продавцов.

API контента для покупок API торговых счетов
blackOwned blackOwned
womenOwned womenOwned
veteranOwned veteranOwned
latinoOwned latinoOwned
smallBusiness smallBusiness
includeForPromotions promotionsConsent
- true означает PROMOTION_CONSENT_GIVEN
- false означает PROMOTION_CONSENT_DENIED

Ресурс AccountIdentityType в Content API представлен типом IdentityAttribute и его identityDeclaration в MerchantAPI.

API контента для покупок API торговых счетов
self_identified identityDeclaration
- true означает SELF_IDENTIFIES_AS
- false означает DOES_NOT_SELF_IDENTIFY_AS

Методы

В API учетных записей торговцев были введены следующие методы:

API контента для покупок API торговых счетов
accounts.authinfo GET https://merchantapi.googleapis.com/accounts/v1beta/accounts без фильтра
accounts.claimwebsite POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/ / homepage /homepage:claim
Дополнительную информацию см. в разделе Метод: account.v1beta.accounts.homepage.claim.
accounts.custombatch Нет в наличии. Специальная партия не поддерживается в Merchant API.
accounts.delete DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId
accounts.get GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId `
accounts.insert POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure
Дополнительную информацию см. в разделе Создание и настройка учетной записи продавца.
accounts.link Ресурс AccountService
accounts.list GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId :listSubaccounts
accounts.listlinks GET https://merchantapi.googleapis.com/accounts/v1beta/ https://merchantapi.googleapis.com/accounts/v1beta/accountId/services /services
accounts.update Сопоставляется с запросом на обновление ресурса, в котором определено необходимое поле или набор полей.