View Source GoogleApi.StreetViewPublish.V1.Api.Photos (google_api_street_view_publish v0.20.0)

API calls for all endpoints tagged Photos.

Summary

Functions

streetviewpublish_photos_batch_delete(connection, optional_params \\ [], opts \\ [])

Deletes a list of Photos and their metadata. Note that if BatchDeletePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchDeletePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchDeletePhotosResponse.results. See DeletePhoto for specific failures that can occur per photo.

streetviewpublish_photos_batch_get(connection, optional_params \\ [], opts \\ [])

Gets the metadata of the specified Photo batch. Note that if BatchGetPhotos fails, either critical fields are missing or there is an authentication error. Even if BatchGetPhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchGetPhotosResponse.results. See GetPhoto for specific failures that can occur per photo.

streetviewpublish_photos_batch_update(connection, optional_params \\ [], opts \\ [])

Updates the metadata of Photos, such as pose, place association, connections, etc. Changing the pixels of photos is not supported. Note that if BatchUpdatePhotos fails, either critical fields are missing or there is an authentication error. Even if BatchUpdatePhotos succeeds, individual photos in the batch may have failures. These failures are specified in each PhotoResponse.status in BatchUpdatePhotosResponse.results. See UpdatePhoto for specific failures that can occur per photo. Only the fields specified in updateMask field are used. If updateMask is not present, the update applies to all fields. The number of UpdatePhotoRequest messages in a BatchUpdatePhotosRequest must not exceed 20. > Note: To update Pose.altitude, Pose.latLngPair has to be filled as well. Otherwise, the request will fail.

streetviewpublish_photos_list(connection, optional_params \\ [], opts \\ [])

Lists all the Photos that belong to the user. > Note: Recently created photos that are still being indexed are not returned in the response.

Functions

streetviewpublish_photos_batch_delete(connection, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photos_batch_delete(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.BatchDeletePhotosResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
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.StreetViewPublish.V1.Model.BatchDeletePhotosRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.BatchDeletePhotosResponse{}} on success
{:error, info} on failure

streetviewpublish_photos_batch_get(connection, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photos_batch_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.BatchGetPhotosResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
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").
- :languageCode (type: String.t) - Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.
- :photoIds (type: list(String.t)) - Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be photoIds=&photoIds=&....
- :view (type: String.t) - Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.BatchGetPhotosResponse{}} on success
{:error, info} on failure

streetviewpublish_photos_batch_update(connection, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photos_batch_update(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.BatchUpdatePhotosResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
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.StreetViewPublish.V1.Model.BatchUpdatePhotosRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.BatchUpdatePhotosResponse{}} on success
{:error, info} on failure

streetviewpublish_photos_list(connection, optional_params \\ [], opts \\ [])

@spec streetviewpublish_photos_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.StreetViewPublish.V1.Model.ListPhotosResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the Photos that belong to the user. > Note: Recently created photos that are still being indexed are not returned in the response.

Parameters

connection (type: GoogleApi.StreetViewPublish.V1.Connection.t) - Connection to server
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. The filter expression. For example: placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw. The filters supported are: placeId, min_latitude, max_latitude, min_longitude, max_longitude. See https://google.aip.dev/160 for more information.
- :languageCode (type: String.t) - Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If language_code is unspecified, the user's language preference for Google services is used.
- :pageSize (type: integer()) - Optional. The maximum number of photos to return. pageSize must be non-negative. If pageSize is zero or is not provided, the default page size of 100 is used. The number of photos returned in the response may be less than pageSize if the number of photos that belong to the user is less than pageSize.
- :pageToken (type: String.t) - Optional. The nextPageToken value returned from a previous ListPhotos request, if any.
- :view (type: String.t) - Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StreetViewPublish.V1.Model.ListPhotosResponse{}} on success
{:error, info} on failure