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. Est en lecture seule pour toutes les autres requêtes. Ce paramètre ne peut pas être modifié.

locationAssociation

object (LocationAssociation)

Obligatoire lors de l'appel de CreatePhoto. Décrit comment cet élément multimédia est associé à son établissement. Doit être soit une catégorie (par exemple, EXTERIOR), soit l'identifiant d'un article de la liste de prix.

Obligatoire lorsque vous ajoutez un élément multimédia à un établissement avec media.create. Pour les autres types d'éléments multimédias, tels que les photos sur les posts locaux, ce champ n'est 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 les vidéos, il s'agit d'une image d'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. Heure de création de cet élément multimédia.

Code temporel au format RFC3339 UTC "Zulu", avec une précision de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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 pour cet élément multimédia.

attribution

object (Attribution)

Uniquement en sortie. Informations sur l'attribution associée aux éléments multimédias des clients. Vous devez afficher cette attribution telle qu'elle vous est fournie à vos utilisateurs. Vous ne devez pas la supprimer ni la modifier.

description

string

Description de cet élément multimédia. Les descriptions ne peuvent pas être modifiées 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 des références de données.

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

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

sourceUrl

string

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

Lors de la création de l'une de ces valeurs, vous devez définir dataRef afin de spécifier la source de l'élément multimédia.

Si vous avez utilisé sourceUrl 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.

Ce champ ne peut pas être modifié.

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.

Lors de la création d'un élément multimédia,

sourceUrl

ou

dataRef

doit être défini.

MediaItemDataRef

Référence aux données binaires de la photo 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 afin d'importer des octets dans [media.upload] et afin d'appeler ensuite 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 de photo 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-le comme dataRef MediaItem.

MediaFormat

Énumération pour le format de l'élément multimé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 acceptées.
VIDEO L'élément multimédia est une vidéo.

LocationAssociation

Type d'association de l'élément multimédia à son établissement.

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 identifiant d'article de liste de prix. Ce n'est pas le cas pour les éléments multimédias qui ne sont pas associés à l'établissement (par exemple, les photos de posts locaux). location_attachment_type ne peut être qu'un des éléments suivants :
category

enum (Category)

Catégorie à laquelle appartient cette photo d'établissement.

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 ne possède qu'une seule photo de couverture.
PROFILE Photo de profil. Un établissement ne possède qu'une seule photo de profil.
EXTERIOR Élément multimédia représentant l'extérieur.
INTERIOR Élément multimédia représentant l'intérieur.
PRODUCT Éléments multimédias représentant un produit.
AT_WORK Élément multimédia représentant le personnel en action.
FOOD_AND_DRINK Élément multimédia représentant des aliments et des boissons.
MENU Élément multimédia représentant le menu.
COMMON_AREA Élément multimédia représentant les espaces communs.
ROOMS Éléments multimédias représentant les chambres.
TEAMS Élément multimédia représentant les équipes.
ADDITIONAL Élément multimédia supplémentaire 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ée à des éléments multimédias de 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, où 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 le lieu.

delete

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

get

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

list

Renvoie 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 d'éléments multimédias.