My Business Business Calls API (mybusinessbusinesscalls:v1)

2022-02-15

3 new methods | New API

Additions

    Methods
  • mybusinessbusinesscalls.locations.getBusinesscallssettings

      Path: v1/{+name}

      Parameters:

        name

          Location: path

          Pattern: ^locations/[^/]+/businesscallssettings$

          Description: Required. The BusinessCallsSettings to get. The `name` field is used to identify the business call settings to get. Format: locations/{location_id}/businesscallssettings.

          Type: string

          Required: Yes

      HTTP Method: GET

      Parameter Order: name

      Flat Path: v1/locations/{locationsId}/businesscallssettings

      Description: Returns the Business calls settings resource for the given location.

  • mybusinessbusinesscalls.locations.updateBusinesscallssettings

      HTTP Method: PATCH

      Parameter Order: name

      Description: Updates the Business call settings for the specified location.

      Path: v1/{+name}

      Flat Path: v1/locations/{locationsId}/businesscallssettings

      Parameters:

        name

          Pattern: ^locations/[^/]+/businesscallssettings$

          Type: string

          Required: Yes

          Description: Required. The resource name of the calls settings. Format: locations/{location}/businesscallssettings

          Location: path

        updateMask

          Type: string

          Format: google-fieldmask

          Location: query

          Description: Required. The list of fields to update.

  • mybusinessbusinesscalls.locations.businesscallsinsights.list

      Path: v1/{+parent}/businesscallsinsights

      Description: Returns insights for Business calls for a location.

      Parameters:

        filter

          Type: string

          Location: query

          Description: Optional. A filter constraining the calls insights to return. The response includes only entries that match the filter. If the MetricType is not provided, AGGREGATE_COUNT is returned. If no end_date is provided, the last date for which data is available is used. If no start_date is provided, we will default to the first date for which data is available, which is currently 6 months. If start_date is before the date when data is available, data is returned starting from the date when it is available. At this time we support following filters. 1. start_date="DATE" where date is in YYYY-MM-DD format. 2. end_date="DATE" where date is in YYYY-MM-DD format. 3. metric_type=XYZ where XYZ is a valid MetricType. 4. Conjunctions(AND) of all of the above. e.g., "start_date=2021-08-01 AND end_date=2021-08-10 AND metric_type=AGGREGATE_COUNT" The AGGREGATE_COUNT metric_type ignores the DD part of the date.

        parent

          Required: Yes

          Type: string

          Pattern: ^locations/[^/]+$

          Location: path

          Description: Required. The parent location to fetch calls insights for. Format: locations/{location_id}

        pageToken

          Type: string

          Location: query

          Description: Optional. A page token, received from a previous `ListBusinessCallsInsights` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBusinessCallsInsights` must match the call that provided the page token. Some of the metric_types (e.g, AGGREGATE_COUNT) returns a single page. For these metrics, the pake_token is ignored.

        pageSize

          Description: Optional. The maximum number of BusinessCallsInsights to return. If unspecified, at most 20 will be returned. Some of the metric_types(e.g, AGGREGATE_COUNT) returns a single page. For these metrics, the page_size is ignored.

          Format: int32

          Type: integer

          Location: query

      HTTP Method: GET

      Flat Path: v1/locations/{locationsId}/businesscallsinsights

      Parameter Order: parent