Essentials for YOOtheme Pro
Google Business Profile Source Provider
The Google Business Profile Source feeds data from Google Business Profile supporting Location, Review, Reviews, Media and Posts queries.
Settings
| Setting | Description | Default |
|---|---|---|
| Name | The name that will identify this source instance. | |
| Default Cache Time | The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration. | 3600 |
| Setting | Description |
|---|---|
| Account | The Google Account which to authenticate with. |
| Profile | The Google Business Profile from which to retrieve the locations. |
| Location | The Google Business Profile location from which to create the source. |
Location Query
Fetches a single location from the profile resolving to a Location Type.
| Setting | Description | Default |
|---|---|---|
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
| Multiple Items | ||
| -- Business Hours | A subquery fetching this location open hours. | |
| -- Special Hours | A subquery fetching this location special hours. |
Review Query
Fetches a single review from the profile location resolving to a Review Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Review | The location review which content to fetch. | ✓ | |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Reviews Query
Fetches reviews from the profile location resolving to a list of Review Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Order By | The order by which to fetch the reviews, Latest, Rating Ascending, or Rating Descending. | Latest | |
| Quantity | The maximum amount of reviews to fetch. | 10 | ✓ |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Media Query
Fetches media from the profile location resolving to a list of Media Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Quantity | The maximum amount of media to fetch. | 20 | ✓ |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Posts Query
Fetches posts from the profile location resolving to a list of Post Type.
| Setting | Description | Default | Dynamic |
|---|---|---|---|
| Quantity | The maximum amount of posts to fetch. | 20 | ✓ |
| Cache | The duration in seconds before the cache is invalidated and the query re-executed. | 3600 |
Location Type
Defines the mapping options of a Google Business Profile Location object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this location. | String | |
| Title | The title of this location. | String | Limit |
| Description | The description of this location. | String | Limit |
| Phone | The primary phone number of this location. | String | |
| Website | The website of this location. | String | |
| Category | The primary category that describes this location business. | String | |
| Labels | The free-form tags of this location, separated by a comma. | String | |
| Language | The language of this location. | String | |
| Store Code | The external identifier for this location. | String | |
| Coordinates | The latitude and longitude for this location, separated by a comma. | String | |
| Latitude | The latitude for this location. | String | |
| Longitude | The longitude for this location. | String | |
| Total Reviews | The number of reviews for this location. | Int | |
| Average Rating | The average star rating of all reviews for this location on a scale of 1 to 5, where 5 is the highest rating. | Int | |
| Reviews URI | The Google URI pointing to this location reviews. | String | |
| New Review URI | The Google URI pointing to a form where a new review for this location can be posted. | String | |
| Google Maps URI | The Google Maps URI pointing to this location. | String | |
| Google Maps Place ID | The Google Maps Place ID for this location. | String | |
| Address | The address for this location. | Postal Address |
Review Type
Defines the mapping options of a Google Business Profile Location Review object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this location. | String | |
| Comment | The body of this review comment as plain text with markups. | String | Limit |
| Original Comment | The comment of this review without translation. | String | Limit |
| Translated Comment | The translated comment of this review. | String | Limit |
| Star Rating | The star rating given by this review where five is the highest rated. | Int | |
| Created At | The date this review was created. | String | Date |
| Updated At | The date this review was last modified. | String | Date |
| Reply | The owner/manager of this location's reply to this review. | Review Reply Type | |
| Reviewer | The author of this review. | Reviewer Type |
Review Reply Type
Defines the mapping options of a Google Business Profile Review Reply object.
| Option | Description | Type | Filters |
|---|---|---|---|
| Comment | The body of this reply as plain text with markups. | String | Limit |
| Updated At | The date this reply was last modified. | String | Date |
Reviewer Type
Defines the mapping options of a Google Business Profile Reviewer object.
| Option | Description | Type |
|---|---|---|
| Display Name | The name of the reviewer, only populated with the reviewer's real name if is not anonymous. | String |
| Profile Photo URL | The path to the locally cached reviewer profile photo. | String |
| Is Anonymous | Indicates whether the reviewer has opted to remain anonymous. | Boolean |
Post Type
Defines the mapping options of a Google Business Profile Post object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this post. | String | |
| URL | The link to the post in Google search. | String | |
| Topic Type | The topic type of the post, STANDARD, EVENT, OFFER, or ALERT. | String | |
| Summary | The description/body of the post. | String | |
| Primary Media URL | The path to the locally cached post primary media thumbnail. | String | |
| Language | The language of the post. | String | |
| Created At | The date this post was created. | String | Date |
| Updated At | The date this post was last modified. | String | Date |
| Offer | |||
| Coupon Code | Offer code that is usable in store or online. | String | |
| Redeem Online URL | Online link to redeem this offer. | String | |
| Terms & Conditions | Terms and conditions of this offer. | String |
Media Type
Defines the mapping options of a Google Business Profile Media object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | The unique identifier of this media. | String | |
| Description | The description of this media. | String | Limit |
| Format | The format of this media, PHOTO, VIDEO, OR MEDIA_FORMAT_UNSPECIFIED. | String | |
| Width | The width of the media, in pixels. | String | |
| Height | The height of the media, in pixels. | String | |
| Thumbnail URL | The path to the locally cached media thumbnail. | String | |
| Source URL | A publicly accessible URL where the media can be retrieved from. | String | |
| Google URL | The Google-hosted URL for this media. For video this will be a preview image with an overlaid play icon. | String | |
| Created At | The date this media was created. | String | Date |
| Total Views | The number of times this media has been viewed. | Int | |
| Attribution | |||
| Profile Name | The name of the attributed user. | String | |
| Profile URL | The URL of the attributed user's Google Maps profile page. | String | |
| Profile Photo URL | The path to the locally cached attributed user's profile photo thumbnail. | String | |
| Location Association | |||
| Category | The category that this location photo belongs to. | String | |
| Price List Item ID | The ID of a price list item that this location media is associated with. | String |
Period Type
Defines the mapping options of a Google Business Profile time period object.
| Option | Description | Type | Filters |
|---|---|---|---|
| Open Period | The current period during which the location is open, formated as {start time} - {end time} with a custom time format setting. | String | |
| Open Day | The day of the week this period starts on. | String | |
| Close Day | The day of the week this period ends on. | String | |
| Open Time | The time this period starts on. | String | Time |
| Close Time | The time this period ends on. | String | Time |
Postal Address Type
Defines the mapping options of a Google Business Profile Postal Address object.
| Option | Description | Type |
|---|---|---|
| Organization | The name of the organization for this address. | String |
| Address | The address lines separated by comma. | String |
| Address Full | The address lines with postal, locality and area separated by comma. | String |
| Locality | The city/town portion of this address. | String |
| Sublocality | The sublocality of this address, this can be neighborhoods, boroughs, districts. | String |
| Administrative Area | The highest administrative subdivision which is used for postal addresses of a country or region. | String |
| Region Code | The CLDR region code of the country/region of this address. | String |
| Sorting Code | The country-specific sorting code, if applicable. | String |
| Postal Code | The postal code of this address, if applicable. | String |
| Language Code | The BCP-47 language code of the contents of this address. | String |