REST Resource: accounts.locations.media

Ресурс: Медиаитем

Один медиа-объект.

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 . Описывает, как этот медиа-элемент связан с его местоположением. Должна быть либо категория (например, ЭКСТЕРЬЕР), либо идентификатор позиции прайс-листа.

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

googleUrl

string

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

thumbnailUrl

string

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

createTime

string ( Timestamp format)

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

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

dimensions

object ( Dimensions )

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

insights

object ( MediaInsights )

Только вывод. Статистика для этого медиа-материала.

attribution

object ( Attribution )

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

description

string

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

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

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

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

sourceUrl

string

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

При создании одного из них или dataRef необходимо указать источник медиа-элемента.

Если sourceUrl использовался при создании элемента мультимедиа, он будет заполнен этим исходным URL-адресом при получении элемента мультимедиа.

Это поле не может быть обновлено.

dataRef

object ( MediaItemDataRef )

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

При создании медиа-элемента либо

sourceUrl

или

dataRef

должен быть установлен.

Медиаитемдатареф

Ссылка на двоичные данные фотографии 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 установите это значение как MediaItem dataRef .

Медиаформат

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

Перечисления
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

Высота медиа-элемента в пикселях.

МедиаИнсайтс

Аналитика и статистика по медиа-материалу.

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 для загрузки элемента мультимедиа.