REST Resource: accounts.locations.media

Источник: MediaItem

Отдельный медиа-материал.

JSON-представление 
{
  "name": string,
  "mediaFormat": enum (MediaFormat),
  "locationAssociation": {
    object (LocationAssociation)
  },
  "googleUrl": string,
  "thumbnailUrl": string,
  "createTime": string,
  "dimensions": {
    object (Dimensions)
  },
  "insights": {
    object (MediaInsights)
  },
  "attribution": {
    object (Attribution)
  },
  "description": string,

  // Union field data can be only one of the following:
  "sourceUrl": string,
  "dataRef": {
    object (MediaItemDataRef)
  }
  // End of list of possible types for union field data.
}
Поля
name

string

Имя ресурса для этого медиафайла. accounts/{accountId}/locations/{locationId}/media/{mediaKey}

mediaFormat

enum ( MediaFormat )

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

locationAssociation

object ( LocationAssociation )

Обязателен при вызове функции CreatePhoto . Описывает, как данный медиафайл связан со своим местоположением. Должен быть либо категорией (например, EXTERIOR), либо идентификатором элемента прайс-листа.

Это необходимо при добавлении новых медиафайлов в местоположение с помощью media.create . Для других типов медиафайлов, например, фотографий в локальных сообщениях, эта функция будет отсутствовать.

googleUrl

string

Только для вывода. URL-адрес этого медиафайла, размещенный на сервере Google. Этот URL-адрес не является статическим, так как может меняться со временем. Для видео это будет изображение предварительного просмотра с наложенным значком воспроизведения.

thumbnailUrl

string

Только для вывода. Если указано, URL-адрес миниатюрного изображения для данного медиафайла.

createTime

string ( Timestamp format)

Только для вывода. Время создания этого медиафайла.

Временная метка в формате RFC3339 UTC "Zulu" с разрешением в наносекунды и до девяти дробных знаков. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

dimensions

object ( Dimensions )

Только для вывода. Размеры (ширина и высота) в пикселях.

insights

object ( MediaInsights )

Только для вывода. Статистика по данному медиаматериалу.

attribution

object ( Attribution )

Только для вывода. Информация об авторстве для медиафайлов клиентов. Вы должны отображать эту информацию об авторстве в том виде, в котором она предоставлена ​​вашим пользователям, и не должны удалять или изменять ее.

description

string

Описание для этого медиафайла. Описание нельзя изменить через API Google My Business, но его можно задать при создании нового медиафайла, не являющегося обложкой.

data объединенного поля. Источник данных медиафайла. При создании нового медиафайла необходимо указать либо URL-адрес, либо ссылку на данные.

За исключением категорий PROFILE и COVER , все фотографии должны иметь минимальную ширину 250 пикселей по короткой стороне и размер файла не менее 10240 байт.

Все загружаемые фотографии должны соответствовать требованиям к фотографиям в профиле компании . data могут содержать только один из следующих параметров:

sourceUrl

string

Общедоступный URL-адрес, по которому можно получить доступ к медиафайлу.

При создании такого элемента необходимо указать источник медиафайла с помощью параметра `this` или `dataRef`.

Если параметр sourceUrl был указан при создании медиафайла, то при получении медиафайла он будет заполнен этим URL-адресом источника.

Это поле нельзя обновить.

dataRef

object ( MediaItemDataRef )

Только для ввода. Ссылка на двоичные данные медиафайла, полученные методом media.startUpload .

При создании медиафайла, либо

sourceUrl

или

dataRef

необходимо установить.

MediaItemDataRef

Ссылка на двоичные данные фотографии объекта MediaItem , загруженного через API Google My Business.

Создайте ссылку на данные с помощью media.startUpload и используйте эту ссылку при загрузке байтов в [media.upload] и последующем вызове media.create .

JSON-представление 
{
  "resourceName": string
}
Поля
resourceName

string

Уникальный идентификатор двоичных данных этого медиафайла. Используется для загрузки данных фотографии с помощью [media.upload] и при создании нового медиафайла из этих байтов с помощью media.create .

Пример загрузки байтов: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resourceName}?uploadType=media"

Для вызовов media.create установите это значение в качестве dataRef MediaItem .

MediaFormat

Перечисление для формата медиафайлов.

Перечисления
MEDIA_FORMAT_UNSPECIFIED Формат не указан.
PHOTO Медиафайл — это фотография. В этой версии поддерживаются только фотографии.
VIDEO Видеоматериал представляет собой видеоролик.

Ассоциация местоположения

Как медиаконтент связан с его местоположением.

JSON-представление 
{

  // Union field location_attachment_type can be only one of the following:
  "category": enum (Category),
  "priceListItemId": string
  // End of list of possible types for union field location_attachment_type.
}
Поля
Поле объединения location_attachment_type . Медиафайлы, относящиеся к местоположению, должны иметь либо категорию, либо идентификатор элемента прайс-листа, с которым они связаны. Медиафайлы, не относящиеся к местоположению (например, фотографии локальных сообщений), не должны иметь ни того, ни другого. location_attachment_type может принимать только одно из следующих значений:
category

enum ( Category )

Категория, к которой относится эта фотография места.

priceListItemId

string

Идентификатор позиции прайс-листа, с которой связана эта фотография местоположения.

Категория

Перечисление категорий медиафайлов.

Перечисления
CATEGORY_UNSPECIFIED Неуказанная категория.
COVER Фотография на обложке. У каждого места только одна фотография на обложке.
PROFILE Фотография профиля. У каждого заведения может быть только одна фотография профиля.
EXTERIOR Внешние носители информации.
INTERIOR Внутренние СМИ.
PRODUCT Информационные материалы о продукте.
AT_WORK «Рабочие» СМИ.
FOOD_AND_DRINK СМИ, освещающие тему еды и напитков.
MENU Меню медиа.
COMMON_AREA Медиа в местах общего пользования.
ROOMS Медиа-комнаты.
TEAMS Медиакоманда.
ADDITIONAL Дополнительные, неклассифицированные медиафайлы.

Размеры

Размеры медиафайла.

JSON-представление 
{
  "widthPixels": integer,
  "heightPixels": integer
}
Поля
widthPixels

integer

Ширина медиафайла в пикселях.

heightPixels

integer

Высота медиафайла в пикселях.

MediaInsights

Аналитические данные и статистика по данному материалу в СМИ.

JSON-представление 
{
  "viewCount": string
}
Поля
viewCount

string ( int64 format)

Только вывод. Количество просмотров медиафайла.

Атрибуция

Информация об авторстве медиаконтента, предоставленного клиентами, например, имя и фотография профиля автора.

JSON-представление 
{
  "profileName": string,
  "profilePhotoUrl": string,
  "takedownUrl": string,
  "profileUrl": string
}
Поля
profileName

string

Имя пользователя, которому следует приписать медиафайл.

profilePhotoUrl

string

URL-адрес миниатюры фотографии профиля пользователя, которому она принадлежит.

takedownUrl

string

URL страницы для удаления контента, на которой можно сообщить о неприемлемом содержании.

profileUrl

string

URL страницы профиля пользователя в Google Maps.

Методы

create

 Создает новый медиафайл для указанного местоположения.

delete

 Удаляет указанный медиафайл.

get

 Возвращает метаданные для запрошенного медиафайла.

list

 Возвращает список медиафайлов, связанных с указанным местоположением.

patch

 Обновляет метаданные указанного медиафайла.

startUpload

 Генерирует объект MediaItemDataRef для загрузки медиафайла.