REST Resource: accounts.locations.media

Ressource: MediaItem

Un seul élément multimédia.

Représentation 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.
}
Champs
name

string

Nom de ressource de cet élément multimédia. accounts/{accountId}/locations/{locationId}/media/{mediaKey}

mediaFormat

enum (MediaFormat)

Format de cet élément multimédia. Doit être défini lors de la création de l'élément multimédia et est en lecture seule pour toutes les autres requêtes. Ce paramètre ne peut pas être modifié.

locationAssociation

object (LocationAssociation)

Obligatoire pour l'appel de CreatePhoto. Décrit la manière dont cet élément multimédia est associé à son emplacement. Doit être une catégorie (par exemple, EXTERIOR) ou l'ID d'un article de la liste de prix.

Cette étape est obligatoire lorsque vous ajoutez des contenus multimédias à un établissement avec media.create. Pour les autres types de médias, tels que les photos sur les posts locaux, il ne sera pas disponible.

googleUrl

string

Uniquement en sortie. URL hébergée par Google pour cet élément multimédia. Cette URL n'est pas statique, car elle est susceptible de changer au fil du temps. Pour la vidéo, il s'agit d'un aperçu avec une icône de lecture superposée.

thumbnailUrl

string

Uniquement en sortie. URL d'une vignette de cet élément multimédia, si elle est fournie.

createTime

string (Timestamp format)

Uniquement en sortie. Date et heure de création de cet élément multimédia.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

dimensions

object (Dimensions)

Uniquement en sortie. Dimensions (largeur et hauteur) en pixels.

insights

object (MediaInsights)

Uniquement en sortie. Statistiques sur cet élément multimédia.

attribution

object (Attribution)

Uniquement en sortie. Informations sur l'attribution des éléments multimédias des clients. Vous devez afficher cette mention telle qu'elle a été fournie à vos utilisateurs, et vous ne devez pas la supprimer ni la modifier.

description

string

Description de cet élément multimédia. Vous ne pouvez pas modifier les descriptions via l'API Google My Business, mais vous pouvez les définir lors de la création d'un élément multimédia autre que la photo de couverture.

Champ d'union data. Source de données de l'élément multimédia. Lorsque vous créez un élément multimédia, vous devez fournir une URL ou une référence de données.

À l'exception des catégories PROFILE et COVER, toutes les photos doivent mesurer au moins 250 pixels sur le bord court, avec une taille de fichier d'au moins 10 240 octets.

Toutes les photos importées doivent respecter les Consignes relatives aux photos sur les fiches d'établissement. data ne peut être qu'un des éléments suivants :

sourceUrl

string

URL accessible au public à partir de laquelle l'élément multimédia peut être récupéré.

Lorsque vous créez l'un de ces éléments ou dataRef, vous devez définir la source de l'élément multimédia.

Si sourceUrl a été utilisé lors de la création d'un élément multimédia, il sera renseigné avec cette URL source lors de la récupération de l'élément multimédia.

Impossible de mettre à jour ce champ.

dataRef

object (MediaItemDataRef)

Uniquement en entrée. Référence aux données binaires de l'élément multimédia obtenues par la méthode media.startUpload.

Lorsque vous créez un élément multimédia,

sourceUrl

ou

dataRef

doit être définie.

MediaItemDataRef

Référence aux données binaires des photos d'un MediaItem importé via l'API Google My Business.

Créez une référence de données à l'aide de media.startUpload, puis utilisez-la lorsque vous importez des octets dans [media.upload], puis que vous appelez media.create.

Représentation JSON
{
  "resourceName": string
}
Champs
resourceName

string

ID unique des données binaires de cet élément multimédia. Permet d'importer les données des photos avec [media.upload] et de créer un élément multimédia à partir de ces octets avec media.create.

Exemple d'importation d'octets: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resourceName}?uploadType=media"

Pour les appels media.create, définissez cette valeur sur MediaItem dataRef.

MediaFormat

Énumération pour le format du média.

Enums
MEDIA_FORMAT_UNSPECIFIED Format non spécifié.
PHOTO L'élément multimédia est une photo. Dans cette version, seules les photos sont prises en charge.
VIDEO L'élément multimédia est une vidéo.

LocationAssociation

La manière dont l'élément multimédia est associé à son emplacement.

Représentation 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.
}
Champs
Champ d'union location_attachment_type. L'élément multimédia de l'établissement doit être associé à une catégorie ou à un ID d'article de liste de prix. Les éléments multimédias qui ne sont pas associés à l'établissement (par exemple, les photos des posts locaux) ne doivent contenir ni l'un ni l'autre. location_attachment_type ne peut être qu'un des éléments suivants :
category

enum (Category)

Catégorie à laquelle appartient cette photo de lieu.

priceListItemId

string

Identifiant d'un article de liste de prix auquel cette photo d'établissement est associée.

Catégorie

Énumération pour la catégorie d'élément multimédia.

Enums
CATEGORY_UNSPECIFIED Catégorie non spécifiée.
COVER Photo de couverture Un établissement n'a qu'une seule photo de couverture.
PROFILE Photo du profil. Un établissement ne possède qu'une seule photo de profil.
EXTERIOR Élément multimédia extérieur.
INTERIOR Élément multimédia représentant l'intérieur.
PRODUCT Élément multimédia représentant le produit.
AT_WORK Contenus multimédias au travail
FOOD_AND_DRINK Élément multimédia représentant des aliments et des boissons.
MENU Élément multimédia représentant un menu.
COMMON_AREA Élément multimédia représentant les espaces communs.
ROOMS Élément multimédia représentant les salles.
TEAMS Élément multimédia représentant les équipes.
ADDITIONAL Contenus multimédias supplémentaires sans catégorie.

Dimensions

Dimensions de l'élément multimédia.

Représentation JSON
{
  "widthPixels": integer,
  "heightPixels": integer
}
Champs
widthPixels

integer

Largeur de l'élément multimédia, en pixels.

heightPixels

integer

Hauteur de l'élément multimédia, en pixels.

MediaInsights

Insights et statistiques sur l'élément multimédia.

Représentation JSON
{
  "viewCount": string
}
Champs
viewCount

string (int64 format)

Uniquement en sortie. Nombre de fois où l'élément multimédia a été visionné.

Attribution

Informations sur l'attribution associées aux éléments multimédias des clients, tels que le nom et la photo de profil d'un contributeur

Représentation JSON
{
  "profileName": string,
  "profilePhotoUrl": string,
  "takedownUrl": string,
  "profileUrl": string
}
Champs
profileName

string

Nom d'utilisateur auquel attribuer l'élément multimédia.

profilePhotoUrl

string

URL de la vignette de la photo de profil de l'utilisateur attribué.

takedownUrl

string

URL de la page de retrait, sur laquelle l'élément multimédia peut être signalé s'il est inapproprié.

profileUrl

string

URL de la page de profil Google Maps de l'utilisateur attribué.

Méthodes

create

Crée un élément multimédia pour l'établissement.

delete

Supprime l'élément multimédia spécifié.

get

Affiche les métadonnées de l'élément multimédia demandé.

list

Affiche la liste des éléments multimédias associés à un établissement.

patch

Met à jour les métadonnées de l'élément multimédia spécifié.

startUpload

Génère un MediaItemDataRef pour l'importation de l'élément multimédia.