View Source GoogleApi.MyBusinessPlaceActions.V1.Api.Locations (google_api_my_business_place_actions v0.3.0)
API calls for all endpoints tagged Locations
.
Summary
Functions
Creates a place action link associated with the specified location, and returns it. The request is considered duplicate if the parent
, place_action_link.uri
and place_action_link.place_action_type
are the same as a previous request.
Deletes a place action link from the specified location.
Gets the specified place action link.
Lists the place action links for the specified location.
Updates the specified place action link and returns it.
Functions
mybusinessplaceactions_locations_place_action_links_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec mybusinessplaceactions_locations_place_action_links_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a place action link associated with the specified location, and returns it. The request is considered duplicate if the parent
, place_action_link.uri
and place_action_link.place_action_type
are the same as a previous request.
Parameters
-
connection
(type:GoogleApi.MyBusinessPlaceActions.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the location where to create this place action link.locations/{location_id}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink{}}
on success -
{:error, info}
on failure
mybusinessplaceactions_locations_place_action_links_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec mybusinessplaceactions_locations_place_action_links_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessPlaceActions.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a place action link from the specified location.
Parameters
-
connection
(type:GoogleApi.MyBusinessPlaceActions.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the place action link to remove from the location. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessPlaceActions.V1.Model.Empty{}}
on success -
{:error, info}
on failure
mybusinessplaceactions_locations_place_action_links_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec mybusinessplaceactions_locations_place_action_links_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the specified place action link.
Parameters
-
connection
(type:GoogleApi.MyBusinessPlaceActions.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the place action link to fetch. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink{}}
on success -
{:error, info}
on failure
mybusinessplaceactions_locations_place_action_links_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec mybusinessplaceactions_locations_place_action_links_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessPlaceActions.V1.Model.ListPlaceActionLinksResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the place action links for the specified location.
Parameters
-
connection
(type:GoogleApi.MyBusinessPlaceActions.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the location whose place action links will be listed.locations/{location_id}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. A filter constraining the place action links to return. The response includes entries that match the filter. We support only the following filter: 1. place_action_type=XYZ where XYZ is a valid PlaceActionType. -
:pageSize
(type:integer()
) - Optional. How many place action links to return per page. Default of 10. The minimum is 1. -
:pageToken
(type:String.t
) - Optional. If specified, returns the next page of place action links.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessPlaceActions.V1.Model.ListPlaceActionLinksResponse{}}
on success -
{:error, info}
on failure
mybusinessplaceactions_locations_place_action_links_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec mybusinessplaceactions_locations_place_action_links_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the specified place action link and returns it.
Parameters
-
connection
(type:GoogleApi.MyBusinessPlaceActions.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Optional. The resource name, in the formatlocations/{location_id}/placeActionLinks/{place_action_link_id}
. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, whereplace_action_link_id
will be assigned by the server on successful creation of a new link and returned as part of the response. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The specific fields to update. The only editable fields areuri
,place_action_type
andis_preferred
. If the updated link already exists at the same location with the sameplace_action_type
anduri
, fails with anALREADY_EXISTS
error. -
:body
(type:GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.MyBusinessPlaceActions.V1.Model.PlaceActionLink{}}
on success -
{:error, info}
on failure