Справочник по API Интернет-магазина Chrome

В этом справочнике описаны методы и представление ресурсов, доступные для API публикации Интернет-магазина Chrome. Каждый тип ресурса имеет одно или несколько представлений данных и один или несколько методов. Подробности реализации см. в разделе «Использование API публикации в Интернет-магазине Chrome» .

Предметы

Подробности о ресурсах элементов см. в представлении ресурса . URI относятся к https://www.googleapis.com, если не указано иное.

Операция HTTP-запрос Описание
получать ПОЛУЧАТЬ
/chromewebstore/v1.1/items/ itemId		 Получает элемент Интернет-магазина Chrome. Укажите projection="DRAFT" в URL-адресе (с учетом регистра).
вставлять ПОЧТА
/upload/chromewebstore/v1.1/items		 Вставляет новый элемент.
публиковать ПОЧТА
/chromewebstore/v1.1/
items/ itemId /publish		 Публикует элемент.

Необязательный параметр запроса publishTarget указывает, как будет опубликован элемент. Допустимые значения: "trustedTesters" и "default" .
обновлять ПОМЕЩАТЬ
/upload/chromewebstore/v1.1/
items/ itemId

и

ПОМЕЩАТЬ
/items/ itemId		 Обновляет существующий элемент.

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

{
  "kind": "chromewebstore#item",
  "id": string,
  "publicKey": string,
  "uploadState": string,
  "itemError": [
    (value)
  ]
}
Имя свойства Ценить Описание
id нить Уникальный идентификатор товара.
itemError[] список Подробный, понятный человеку статус операции, только на английском языке. Те же сообщения об ошибках отображаются при загрузке приложения в Интернет-магазин Chrome.
kind нить Идентифицирует этот ресурс как элемент. Значение: фиксированная строка "chromewebstore#item" .
publicKey нить Открытый ключ этого элемента.
uploadState нить Статус операции.

Приемлемые значения:
  • " FAILURE "
  • " IN_PROGRESS "
  • " NOT_FOUND "
  • " SUCCESS "

Получать

Получает элемент Интернет-магазина Chrome. Укажите projection="DRAFT" (с учетом регистра) в качестве параметра URL.

Запрос

HTTP-запрос

GET https://www.googleapis.com/chromewebstore/v1.1/items/itemId

Параметры

Имя параметра Ценить Описание
Параметры пути
itemId нить Уникальный идентификатор, представляющий приложение Chrome, расширение Chrome или тему Chrome.
Необязательные параметры запроса
projection нить Определяет, какое подмножество информации об элементе нужно вернуть.

Приемлемые значения:
  • « DRAFT »: возврат информации, извлеченной из текущего черновика.
  • « PUBLISHED »: возврат информации, извлеченной из черновика опубликованного элемента.
Обратите внимание, что в настоящее время поддерживается только "DRAFT" .

Авторизация

Для этого запроса требуется авторизация со следующей областью действия.

https://www.googleapis.com/auth/chromewebstore.readonly

Приведенный выше URL-адрес используется в качестве параметра области при создании токена доступа. Более подробную информацию об авторизации и аутентификации API см. в документации OAuth 2.0 .

Тело запроса

Не предоставляйте тело запроса с помощью этого метода.

Ответ

В случае успеха этот метод возвращает ресурс Items в теле ответа.

Вставлять

Вставляет новый элемент .

Этот метод поддерживает URI загрузки и принимает загруженные медиафайлы.

Запрос

HTTP-запрос

POST https://www.googleapis.com/upload/chromewebstore/v1.1/items

Параметры

Имя параметра Ценить Описание
Обязательные параметры запроса
uploadType нить Тип запроса на загрузку по URI /upload . Единственное допустимое значение — media : простая загрузка медиаданных.
Необязательные параметры запроса
publisherEmail нить Электронная почта издателя, которому принадлежат объекты. По умолчанию используется адрес электронной почты вызывающего абонента.

Авторизация

Для этого запроса требуется авторизация со следующей областью действия.

https://www.googleapis.com/auth/chromewebstore

Приведенный выше URL-адрес используется в качестве параметра области при создании токена доступа. Более подробную информацию об авторизации и аутентификации API см. в документации OAuth 2.0 .

Тело запроса

Не предоставляйте тело запроса с помощью этого метода.

Ответ

В случае успеха этот метод возвращает ресурс Items в теле ответа.

Публиковать

Публикует элемент . Укажите определенный publicTarget в URL-адресе (с учетом регистра):PublishTarget = «trustedTesters» илиPublishTarget = «default».

Запрос

HTTP-запрос

POST https://www.googleapis.com/chromewebstore/v1.1/items/itemId/publish

Параметры

Имя параметра Ценить Описание
Параметры пути
itemId нить Идентификатор элемента для публикации.
Необязательные параметры запроса
publishTarget нить Укажите определенный publishTarget в URL-адресе (с учетом регистра): publishTarget="trustedTesters" publishTarget="default" . По умолчанию publishTarget="default" .

Тело запроса

В теле запроса при желании можно указать данные следующей структуры:

JSON

{
  "target": string
}
Имя свойства Ценить Описание
target string Цель публикации этой операции публикации. Это то же самое, что использовать publicTarget в качестве параметра запроса URL. Строковое значение может быть либо target="trustedTesters", либо target="default". Значение по умолчанию, если оно не указано, — target="default". Рекомендуемое использование — использовать параметр запроса URL-адреса для указания значения.

Авторизация

Для этого запроса требуется авторизация со следующей областью действия.

https://www.googleapis.com/auth/chromewebstore

Приведенный выше URL-адрес используется в качестве параметра области при создании токена доступа. Более подробную информацию об авторизации и аутентификации API см. в документации OAuth 2.0 .

Ответ

В случае успеха этот метод возвращает тело ответа следующей структуры:

{
  "kind": "chromewebstore#item",
  "item_id": string,
  "status": [
    string
  ],
  "statusDetail": [
    string
  ]
}
Имя свойства Ценить Описание
kind string Значением статической строки всегда является "chromewebstore#item" .
item_id string Идентификатор этого элемента.
status[] list Код состояния этой операции публикации. Он может содержать несколько элементов из следующего списка: OK , NOT_AUTHORIZED , INVALID_DEVELOPER , DEVELOPER_NO_OWNERSHIP , DEVELOPER_SUSPENDED , ITEM_NOT_FOUND , ITEM_PENDING_REVIEW , ITEM_TAKEN_DOWN , PUBLISHER_SUSPENDED .
statusDetail[] list Подробное, понятное человеку объяснение приведенного выше кода состояния.

Обновлять

Обновляет существующий элемент .

Этот метод поддерживает URI загрузки и принимает загруженные медиафайлы.

Запрос

HTTP-запрос

Этот метод обеспечивает функцию загрузки мультимедиа через два отдельных URI.

  • URI загрузки для запросов на загрузку мультимедиа:

    PUT https://www.googleapis.com/upload/chromewebstore/v1.1/items/itemId

  • URI метаданных для запросов только метаданных:

    PUT https://www.googleapis.com/chromewebstore/v1.1/items/itemId

Параметры

Имя параметра Ценить Описание
Параметры пути
itemId string Идентификатор элемента для загрузки.
Обязательные параметры запроса
uploadType string Тип запроса на загрузку по URI /upload . Допустимые значения: media — простая загрузка. Загружайте только медиафайлы без каких-либо метаданных.

Тело запроса

В тексте запроса укажите ресурс Items в качестве метаданных.

Авторизация

Для этого запроса требуется авторизация со следующей областью действия.

https://www.googleapis.com/auth/chromewebstore

Приведенный выше URL-адрес используется в качестве параметра области при создании токена доступа. Более подробную информацию об авторизации и аутентификации API см. в документации OAuth 2.0 .

Ответ

В случае успеха этот метод возвращает ресурс Items в теле ответа.