Questo tutorial mostra come creare e modificare i dati sulla posizione. L'API My Business Business Information ti consente di:
- Crea una nuova sede.
- Eliminare una sede.
- Ottieni una località in base al nome della risorsa.
- Elenca tutte le sedi per un account.
- Aggiorna uno o più campi per una sede.
Le località possono essere utilizzate in Google Ads, ma devono essere verificati di avere l'idoneità a vengono visualizzati nella Ricerca e su Maps. I dati sulla posizione sono rappresentati accounts.locations .
Prima di iniziare
Prima di utilizzare l'API My Business Business Information, devi registrare il tuo l'applicazione e ottenere le credenziali OAuth 2.0. Per informazioni dettagliate su come iniziare con l'API My Business Business Information, consulta Configurazione di base.
Crea una località
Puoi utilizzare l'API My Business Business Information per creare una nuova sede per un'attività commerciale con accounts.locations.create.
Per creare una sede, utilizza quanto segue:
POST
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?requestId=requestId&validateOnly=True|False
{
"storeCode": "GOOG-SYD",
"languageCode": "en-AU",
"title": "Google Sydney",
"phoneNumbers": {
"primaryPhone": "02 9374 4000"
}
"storefrontAddress": {
"addressLines": [
"Level 5",
"48 Pirrama Road"
],
"locality": "Pyrmont",
"postalCode": "2009",
"administrativeArea": "NSW",
"regionCode": "AU"
},
"websiteUri": "https://www.google.com.au/",
"regularHours": {
"periods": [
{
"openDay": "MONDAY",
"closeDay": "MONDAY",
"openTime": "09:00",
"closeTime": "17:00"
},
{
"openDay": "TUESDAY",
"closeDay": "TUESDAY",
"openTime": "09:00",
"closeTime": "17:00"
},
{
"openDay": "WEDNESDAY",
"closeDay": "WEDNESDAY",
"openTime": "09:00",
"closeTime": "17:00"
},
{
"openDay": "THURSDAY",
"closeDay": "THURSDAY",
"openTime": "09:00",
"closeTime": "17:00"
},
{
"openDay": "FRIDAY",
"closeDay": "FRIDAY",
"openTime": "09:00",
"closeTime": "17:00"
}
]
},
"categories": {
"primaryCategory": {
"name": "gcid:software_company"
}
}
}
Eliminare una località
Puoi utilizzare l'API My Business Business Information per eliminare una sede con locations.delete.
Per eliminare una posizione, utilizza quanto segue:
DELETE
https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}
Trova una località per nome
Se hai molte attività associate al tuo account, potresti voler ottenere in una singola località. Puoi filtrare per attività per ottenere un nome posizione con locations.get.
Per ottenere una posizione per nome, utilizza il seguente codice. Devi specificare una readMask per recuperare campi specifici. :
GET
https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?readMask={commaSeparatedFieldsToRetrieve}
Restituire la versione di Google Maps
Per restituire la versione di Google Maps di una località, aggiungi
googleUpdated all'URL della richiesta, come nell'esempio seguente:
GET
https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}:googleUpdated?readMask={commaSeparatedFieldsToRetrieve}
Se non vengono restituiti risultati, viene visualizzato un codice di stato HTTP 404 NOT FOUND
restituito. Puoi trovare ulteriori dettagli sulla gestione degli aggiornamenti Google qui.
Elenco località
Quando gestisci una o più sedi, è consigliabile elencare da tutte le sedi associate al tuo account. Utilizza la accounts.locations.list API per elencare tutte le località associate a un utente.
Per elencare tutte le sedi direttamente di proprietà o gestite da un utente autenticato, utilizza le seguenti:
GET
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}
Utilizza un carattere jolly '-' per l'account nell'URL della richiesta, in modo da includere il carattere
Schede di proprietà indiretta (di proprietà o gestite tramite un gruppo):
GET
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/-/locations?readMask={commaSeparatedFieldsToRetrieve}
Filtrare i risultati quando si elencano le località
Puoi utilizzare i filtri per limitare i risultati restituiti quando chiami accounts.locations.list. Per filtrare una richiesta, aggiungi un'espressione di filtro all'URL di base, come mostrato in in questo esempio:
GET
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter={FIELD_NAME}=%22{YOUR_QUERY}%22
Sintassi delle query di base
Una restrizione ha la seguente sintassi:
<field><operator><value>,
in cui l'operatore è EQUALS (=) o HAS (:). Uguale a (=) e HAS (:)
gli operatori sono equivalenti per tutti i campi tranne locationName (vedi
riportata di seguito).
Le virgolette sono codificate come "%22" e spazi come segni più (+).
Se non indicato diversamente, tutti i confronti non fanno distinzione tra maiuscole e minuscole per i confronti. Ad esempio, "4 in auto" corrisponde a "4, Privet Drive".
Combinare più campi in una query di filtro
L'API consente a AND di connettere tutte le limitazioni dei campi. Tuttavia,
per la parola chiave OR, tutte le restrizioni devono essere applicate alla stessa
. Ad esempio: locationName=A OR labels=B non è
consentito.
Esempio
L'esempio seguente mostra un'espressione di filtro che restituisce tutte le località con il nome "Pepé Le Pew". Mostra le categorie per "ristorante_francese" o "ristorante_europeo," e l'etichetta "nuovamente aperto".
locationName=%22Pepé+Le+Pew%22+AND+ (categories=%22french_restaurant%22+OR+ categories=%22european_restaurant%22)+AND+ labels=%22newly+open%22
Cerca per distanza o account
L'esempio seguente mostra come cercare località all'interno di un determinato distanza da un punto geografico:
GET
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter=distance(latlng, geopoint({latitude}, {longitude}))<{distance}
Per filtrare le località entro 1600 miglia da Boulder, Colorado, Stati Uniti:
GET
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter=distance(latlng, geopoint(40.01, -105.27))<1000.0
Elenco di tutti i campi filtro supportati
Di seguito è riportato un elenco completo di tutti i campi che possono essere utilizzati filtro:
| Campi | Descrizione ed esempio |
|---|---|
| Campi corrispondenti alle stringhe | |
title |
L'attività nome reale
|
categories |
La combinazione della categoria principale e delle categorie aggiuntive. Tieni presente che la stringa "gcid:" deve essere omesso. Se ci sono più parametri categorie, questo filtro corrisponde se almeno una categoria corrisponde a questa pattern.
|
phone_numbers.primary_phone |
Il numero di telefono principale nel formato E.164 (ad es. "+441234567890").
|
storefront_address.region_code |
Il codice regione CLDR del paese o della regione dell'indirizzo
|
storefront_address.administrative_area |
La suddivisione amministrativa di livello più alto utilizzata per gli indirizzi postali di un paese o di una regione
|
storefront_address.locality |
La parte della città o del paese dell'indirizzo
|
storefront_address.postal_code |
Il codice postale dell'indirizzo
|
metadata.place_id |
Se questa sede è stata verificata ed è collegata o viene visualizzata su Google Maps, questo campo corrisponde all'ID luogo della sede
|
openInfo.status |
Indica se la sede è attualmente aperta o meno
(
|
labels |
Una raccolta di stringhe in formato libero che ti consente di taggare la tua attività. Nella rispetto a tutti gli altri campi, questo valore deve corrispondere esattamente a un che include lettere maiuscole e minuscole e non solo un token. Ad es. Se un'etichetta è "XX YY", quindi nessuna delle due opzioni o "xx yy" corrisponderanno.
|
storeCode |
Identificatore esterno per questa località, che deve essere univoco all'interno di un determinato account
|
| Funzioni | |
distance |
Consente di filtrare in base alla distanza della posizione da un punto geografico.
|
Ordina per campo di query
Puoi ordinare i risultati per nome dell'attività o codice negozio, in ordine crescente
in ordine decrescente. Più criteri di ordinamento sono separati da virgole
Stringa orderBy, come nell'esempio seguente:
GET
https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&orderBy=locationName,storeCode
Applicare la patch a una posizione
Utilizza l'API My Business Business Information per aggiornare uno o più campi per una sede con locations.patch.
Per modificare uno o più campi per una sede, utilizza quanto segue:
Aggiungi i campi e i valori aggiornati con il campo della località e utilizza un
elenco separato da virgole di campi aggiornati come valore per fieldMask.
PATCH
https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?languageCode=language&validateOnly=True|False&updateMask=title
{
"title": "Google Shoes"
}