Documentation

Google_Service_StreetViewPublish_Resource_Photos extends Google_Service_Resource
in package

The "photos" collection of methods.

Typical usage is: $streetviewpublishService = new Google_Service_StreetViewPublish(...); $photos = $streetviewpublishService->photos;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchDelete()  : Google_Service_StreetViewPublish_BatchDeletePhotosResponse
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. (photos.batchDelete)
batchGet()  : Google_Service_StreetViewPublish_BatchGetPhotosResponse
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. (photos.batchGet)
batchUpdate()  : Google_Service_StreetViewPublish_BatchUpdatePhotosResponse
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.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listPhotos()  : Google_Service_StreetViewPublish_ListPhotosResponse
Lists all the Photos that belong to the user. *Note:* Recently created photos that are still being indexed are not returned in the response.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

batchDelete()

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. (photos.batchDelete)

public batchDelete(Google_Service_StreetViewPublish_BatchDeletePhotosRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_StreetViewPublish_BatchDeletePhotosResponse
Parameters
$postBody : Google_Service_StreetViewPublish_BatchDeletePhotosRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_StreetViewPublish_BatchDeletePhotosResponse

batchGet()

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. (photos.batchGet)

public batchGet([array<string|int, mixed> $optParams = array() ]) : Google_Service_StreetViewPublish_BatchGetPhotosResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string view Required. Specifies if a download URL for the photo bytes should be returned in the Photo response.

opt_param

string photoIds Required. IDs of the Photos. For HTTP GET requests, the URL query parameter should be photoIds==&....

opt_param

string languageCode 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.

Return values
Google_Service_StreetViewPublish_BatchGetPhotosResponse

batchUpdate()

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.

public batchUpdate(Google_Service_StreetViewPublish_BatchUpdatePhotosRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_StreetViewPublish_BatchUpdatePhotosResponse

(photos.batchUpdate)

Parameters
$postBody : Google_Service_StreetViewPublish_BatchUpdatePhotosRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_StreetViewPublish_BatchUpdatePhotosResponse

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

listPhotos()

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

public listPhotos([array<string|int, mixed> $optParams = array() ]) : Google_Service_StreetViewPublish_ListPhotosResponse

(photos.listPhotos)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter Required. The filter expression. For example: placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw. The only filter supported at the moment is placeId.

opt_param

int pageSize 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.

opt_param

string languageCode 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.

opt_param

string view Required. Specifies if a download URL for the photos bytes should be returned in the Photos response.

opt_param

string pageToken The nextPageToken value returned from a previous ListPhotos request, if any.

Return values
Google_Service_StreetViewPublish_ListPhotosResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results