Class: module:api/BucketsApi

module:api/BucketsApi(apiClient)

new module:api/BucketsApi(apiClient)

Constructs a new BucketsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.
Source:

Methods

createBucket(postBuckets, opts, oauth2client, credentials)

Use this endpoint to create a bucket. Buckets are arbitrary spaces created and owned by applications. Bucket keys are globally unique across all regions, regardless of where they were created, and they cannot be changed. The application creating the bucket is the owner of the bucket.

Parameters:
Name Type Description
postBuckets module:model/PostBucketsPayload

Body Structure
opts Object

Optional parameters

Properties
Name Type Description
xAdsRegion module:model/String

The region where the bucket resides Acceptable values: US, EMEA Default is US (default to US) data is of type: {module:model/Bucket}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

deleteBucket(bucketKey, oauth2client, credentials)

This endpoint will delete a bucket.

Parameters:
Name Type Description
bucketKey String

URL-encoded bucket key
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getBucketDetails(bucketKey, oauth2client, credentials)

This endpoint will return the buckets owned by the application. This endpoint supports pagination.

Parameters:
Name Type Description
bucketKey String

URL-encoded bucket key data is of type: {module:model/Bucket}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source:

getBuckets(opts, oauth2client, credentials)

This endpoint will return the buckets owned by the application. This endpoint supports pagination.

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
region module:model/String

The region where the bucket resides Acceptable values: US, EMEA Default is US (default to US)
limit Integer

Limit to the response size, Acceptable values: 1-100 Default = 10 (default to 10)
startAt String

Key to use as an offset to continue pagination This is typically the last bucket key found in a preceding GET buckets response data is of type: {module:model/Buckets}
oauth2client Object

oauth2client for the call
credentials Object

credentials for the call
Source: