Skip to content

Latest commit

 

History

History
704 lines (636 loc) · 35.9 KB

USAGE.md

File metadata and controls

704 lines (636 loc) · 35.9 KB
Raw

Usage

AdobeStock

Instantiation

  • The AdobeStock class requires that:

    • apiKey be passed in to set x-api-key header for Stock API calls.
    • product be passed in to set x-product header for Stock API calls.
    • targetEnv be passed in to determine stack of Stock API endpoints. It is optional and if not passed Stage stack is set by default.

  • Environment Description:

    • STAGE Uses internal staging environment. Mainly used for testing purposes.
    • PROD Used in development purposes.

Methods

  • The AdobeStock class allows you to:

    • ENVIRONMENT - Get environment constant which is used to defined the stack of Stock APIs endpoints.

    • SEARCH_PARAMS - Get the different search_parameters which can be used for creating a search_parameters object.

    • LICENSE_HISTORY_SEARCH_PARAMS - Get the different search_parameters which can be used for creating a search_parameters object for use with the license history API

    • SEARCH_PARAMS_ORDER - Get the valid strings for order search parameter

    • SEARCH_PARAMS_HAS_RELEASES - Get the valid strings for has_releases filter search parameter

    • SEARCH_PARAMS_3D_TYPES - Get the valid values for 3D type filter for the 3D asset

    • SEARCH_PARAMS_TEMPLATE_CATEGORIES - Get the valid values for template_category_id array filter search parameter

    • SEARCH_PARAMS_TEMPLATE_TYPES - Get the valid values for template_type_id array filter search parameter

    • SEARCH_PARAMS_THUMB_SIZES - Get the valid values for thumbnail_size filter search parameter

    • SEARCH_PARAMS_AGE - Get the valid string values for age filter search parameter

    • SEARCH_PARAMS_VIDEO_DURATION - Get the valid string values for video_duration filter search parameter

    • SEARCH_PARAMS_PREMIUM - Get the valid strings for the premium filter search parameter

    • RESULT_COLUMNS - Get the list of result columns supported to be used for passing with searchFiles which to be included in the search results

    • LICENSE_HISTORY_RESULT_COLUMNS - Get the list of result columns supported to be used for passing with licenseHistory which to be additionally included in the license history results

    • searchFiles - Creates an iterator for Stock photo search results.

      • Parameters:

        • accessToken - the accessToken string or should be null if the is_licensed result column was not requested in the results. (Required)
        • queryParams - the object of query parameters. (Required)
        • resultColumns - the list of result columns required in search results. (Optional)

      • Returns:

        • Returns object of SearchFilesIterator class

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const queryParams = {
  locale: 'en-US',
  search_parameters: {
    words: 'tree house',
    limit: 10,
    offset: 10,
    filters_template_category_id: [
      AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PRINT,
      AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
    ],
    filters_area_pixels: '0-2500',
  },
};
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.searchFiles(accessToken,
                                    queryParams,
                                    null);
iterator.next().then(() => {
  const response = iterator.getResponse();
  console.log(response.files.length);
});

    • searchFilesByCategory - variant of the searchFiles method. It takes categoryId, locale, filters as arguments instead of a queryParams object. Returns an iterator of results for the provided category.

      • Requires:

        • accessToken - the accessToken string or should be null if the is_licensed result column was not requested in the results. (Required)
        • categoryId - the category for which to perform a search for. (Required)
        • locale - the locale for which to perform a search for. (Optional)
        • filters - an array of filters for use in the search. If filters contains category then filters.category will override the categoryId passed as a separate argument. (Optional)
        • resultColumns - the list of result columns required in search results. (Optional)

      • Returns:

        • Returns object of SearchFilesIterator class

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const filters = {
  filters_template_category_id: [
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PRINT,
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
  ],
  filters_area_pixels: '0-2500',
};
const resultColumns = [
  AdobeStock.RESULT_COLUMNS.ID,
  AdobeStock.RESULT_COLUMNS.TITLE,
  AdobeStock.RESULT_COLUMNS.NB_RESULTS,
];
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.searchFilesByCategory(accessToken,
                                    695, // category
                                    'en-US',
                                    filters,
                                    resultColumns);
iterator.next().then(() => {
  const response = iterator.getResponse();
  console.log(response.files.length);
});

    • searchSimilarFilesById - variant of searchFiles method. It takes mediaId, locale, filters as arguments instead of a queryParams object. Returns an iterator of results for the provided media.

      • Requires:

        • accessToken - the accessToken string or should be null if the is_licensed result column was not requested in the results. (Required)
        • mediaId - the value of Stock media id for which to perform the search for. (Required)
        • locale - the locale for which to perform a search for. (Optional)
        • filters - an array of filters for use in the search. If filters contains mediaId then filters.mediaId will override the mediaId passed as a separate argument. (Optional)
        • resultColumns - the list of result columns required in search results. (Optional)

      • Returns:

        • Returns object of SearchFilesIterator class

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const filters = {
  filters_template_category_id: [
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PRINT,
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
  ],
  filters_area_pixels: '0-2500',
};
const resultColumns = [
  AdobeStock.RESULT_COLUMNS.ID,
  AdobeStock.RESULT_COLUMNS.TITLE,
  AdobeStock.RESULT_COLUMNS.NB_RESULTS,
];
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.searchSimilarFilesById(accessToken,
                                    13244222, // media id
                                    'en-US',
                                    filters,
                                    resultColumns);
iterator.next().then(() => {
  const response = iterator.getResponse();
  console.log(response.files.length);
});

    • searchFilesByKeywords - a variant of the searchFiles method. It takes keywords, locale, filters as arguments instead of a queryParams object. Returns an iterator of results for the provided media.

      • Requires:

        • accessToken - the accessToken string or should be null if the is_licensed result column was not requested in the results. (Required)
        • keywords - the search keywords for which to perform the search for. (Required)
        • locale - the locale for which to perform a search for. (Optional)
        • filters - an array of filters for use in the search. If filters contains words then filters.words will override the keywords passed as a separate argument. (Optional)
        • resultColumns - the list of result columns required in search results. (Optional)

      • Returns:

        • Returns object of SearchFilesIterator class

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const filters = {
  filters_template_category_id: [
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PRINT,
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
  ],
  filters_area_pixels: '0-2500',
};
const resultColumns = [
  AdobeStock.RESULT_COLUMNS.ID,
  AdobeStock.RESULT_COLUMNS.TITLE,
  AdobeStock.RESULT_COLUMNS.NB_RESULTS,
];
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.searchFilesByKeywords(accessToken,
                                    'tree house', // search keywords
                                    'en-US',
                                    filters,
                                    resultColumns);
iterator.next().then(() => {
  const response = iterator.getResponse();
  console.log(response.files.length);
});

    • searchCategory - Retrieve category information for a specified category identifier.

      • Requires:

        • locale - the locale for which to perform the search for. (Optional)
        • category_id - unique identifier for an existing category. Results are returned for this category. (Required)

      • Returns:

        • Returns a Promise object with response as JSON structure of this format: { "id": ..., "link": "...", "name": "..." }

      • Example:

        const queryParams = {
  locale: 'en-US',
  category_id: 1043,
  },
};
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const promise = stock.searchCategory(queryParams);
promise.then((response) => {
  console.log("category response : " + response);
});

    • searchCategoryTree - Retrieve category information for zero or more category identifiers. If you request information without specifying a category, the Stock API returns a list of all Adobe Stock categories.

      • Requires:

        • locale - the locale for which to perform the search for. (Optional)
        • category_id - unique identifier for an existing category. Results are returned for this category. (Optional)

      • Returns:

        • Returns a Promise object with response as JSON array that can contain multiple category structures: [ { "id": ..., "link": "...", "name": "..." }, { "id": ..., "link": "...", "name": "..." } ]

      • Example:

        const queryParams = {
  locale: 'en-US',
  category_id: 1043,
  },
};
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const promise = stock.searchCategory(queryParams);
promise.then((response) => {
  console.log("category response : " + response);
});

    • accessMemberProfile - Retrieve licensing capabilities for a specific user. This API returns the user's available purchase quota, the member identifier, and information that you can use to present licensing options to the user when the user next requests an asset purchase. Three cases can occur:

      1. User has enough quota to license the next asset.
      2. User doesn't have enough quota and is set up to handle overage.
      3. User doesn't have quota and there is no overage plan.

      • Requires:

        • accessToken - access token to be used for Authorization header. (Required)
        • contentId - asset's unique identifer. (Optional)
        • license - Adobe Stock licensing state for the asset. Takes default value Standard if not present.(Optional).
        • locale - Location language code for the API to use when returning localized messages. (Optional)

      • Returns:

        • Returns object of Promise class containing JSON data for member profile

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const contentId = 1234;
const license = "STANDARD";
const locale = "en_US"
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);

stock.accessMemberProfile(accessToken, contentId, license, locale).then((response) => {
  console.log(response);
});

    • memberAbandonLicensing - Notifies the system when a user cancels a licensing operation. It can be used if the user refuses the opportunity to purchase or license the requested asset.

      • Requires:

        • accessToken - access token to be used for Authorization header. (Required)
        • contentId - asset's unique identifier. (Required)
        • state - user's purchase relationship to an asset. (Required)

      • Returns:

        • Returns object of Promise class with data '204 No Content'

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const contentId = 1234;
const state = "not_purchased";
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);

stock.memberAbandonLicensing(accessToken, contentId, state).then((response) => {
  console.log(response);
}, (error) => {
  console.log(error);
});

    • getLicenseInfoForContent - Requests licensing information for a specific asset for a specific user.

      • Requires:

        • accessToken - access token to be used for Authorization header. (Required)
        • contentId - asset's unique identifier. (Required)
        • license - Adobe Stock licensing state for the asset. Takes default value Standard if not present. (Optional)

      • Returns:

        • Returns object of Promise class containing JSON data for license info

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const contentId = 1234;
const license = "STANDARD";
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);

stock.getLicenseInfoForContent(accessToken, contentId, license).then((response) => {
  console.log(response);
});

    • requestLicenseForContent - Requests a license for an asset for a specific user.

      • Requires:

        • accessToken - access token to be used for Authorization header. (Required)
        • contentId - asset's unique identifer. (Required)
        • license - Adobe Stock licensing state for the asset. Takes default value Standard if not present.(Optional)
        • cceAgency - array of license reference objects. Each object contains two attributes: id and value. The license reference id values can be found using the accessMemberProfile API. License references are required to be provided in enterprise accounts if your account is configured to provide references. (Optional)

      • Returns:

        • Returns object of Promise class containing JSON data for license info with download URL

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const contentId = 1234;
const license = "STANDARD";
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);

stock.requestLicenseForContent(accessToken, contentId, license).then((response) => {
  console.log(response);
});

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
  const contentId = 1234;
  const license = "STANDARD";
  const locale = "en-US";
  const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);

  var cceAgency;
  stock.accessMemberProfile(accessToken, contentId, license, locale).then((response) => {
    console.log(response);
    cceAgency = response.cce_agency;

    //this response object contains cce_agency array which contains license references containing "id".
    var iterator;
    var cceAgencyLength = response.cce_agency.length;
    for (iterator = 0; iterator < cceAgencyLength; iterator++) {
      cceAgency[iterator].value = "org_name";
    }

    stock.requestLicenseForContent(accessToken, contentId, license, cceAgency).then((response) => {
      console.log(response);
    });
  });

    • downloadAsset - Retrieve the URL of the asset if it is already licensed.

      • Requires:

        • accessToken - access token to be used for Authorization header. (Required)
        • contentId - asset's unique identifier. (Required)
        • license - Adobe Stock licensing state for the asset. Takes default value Standard if not present. (Optional)

      • Returns:

        • Returns object of Promise class containing URL of the asset URL

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const contentId = 1234;
const license = "STANDARD";
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);

stock.downloadAsset(accessToken, contentId, license).then((response) => {
  console.log(response);
});

    • licenseHistory - Get an iterator for reviewing license history results.

      • Requires:

        • accessToken - the accessToken string. (Required)
        • queryParams - the object of query parameters. (Required)
        • resultColumns - the list of result columns additionally required in license history results. (Optional)

      • Returns:

        • Returns object of LicenseHistoryIterator class

      • Example:

        const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const queryParams = {
  locale: 'en-US',
  search_parameters: {
    limit: 10,
    offset: 10,
  },
};
const resultColumns = [
  AdobeStock.LICENSE_HISTORY_RESULT_COLUMNS.THUMBNAIL_110_URL,
];
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.licenseHistory(accessToken,
                                      queryParams,
                                      resultColumns);
iterator.next().then(() => {
  const response = iterator.getResponse();
  console.log(response.files.length);
});

SearchFilesIterator

It maintains the current state of a searchFiles response. Initially, the state is pointed before the first searchFiles response. The next method moves the state to the next page and fetches the response for it. The previous and skipTo methods can be used to move one page behind or skip to a particular search page index respectively. The iterator implements pagination of the results for you.

This class can't be instantiated or constructed on its own. The AdobeStock searchFiles methods return instances of the SearchFilesIterator class.

Methods

  • The SearchFilesIterator class allows you to:
    • totalSearchFiles - Get the total number of search files available. Initially, since the state is pointing before the first response, it returns -1.
    • totalSearchPages - Get the total number of search pages available. Initially, since the state is pointing before the first response, it returns -1.
    • currentSearchPageIndex - Get the current search page index of searchFiles results available from recently performed next or previous or skipTo method invocations. Initially, since the state is pointing before the first response, it returns -1.
    • getResponse - Get the response object of recently performed searchFiles API call either by using next or previous or skipTo. Initially, this method will return an empty object since it is pointing to before the first searchFiles response.
    • next - It moves the state to the next page and fetches its results. It returns a promise where it resolves the promise if the searchFiles API returns successfully and rejects if there is any failure using the searchFiles API or if it already hit the last page of results.
    • previous - It moves the state to the previous page and fetches its results. It returns a promise where it resolves the promise if the searchFiles API returns successfully and rejects if there is any failure using the searchFiles API, if it already hit the first page of results or if the iterator is pointing before the first searchFiles response.
    • skipTo - It moves the state to the provided search page and fetches its results. It returns a promise where it resolves the promise if the searchFiles API returns successfully and rejects if there is any failure using the searchFiles API or if the provided search page index is out of bounds.
      • Requires:
        • pageIndex - page index to skip to. It is a zero-based index.

Example

const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const queryParams = {
locale: 'en-US',
search_parameters: {
  words: 'tree house',
  limit: 10,
  offset: 10,
  filters_template_category_id: [
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PRINT,
    AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
  ],
  filters_area_pixels: '0-2500',
},
};
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.searchFiles(accessToken,
                                  queryParams,
                                  null);
// returns with error
iterator.previous()
      .then(() => {})
      .catch((error) => {
        console.error(error);
      });

// returns with success
iterator.next().then(() => {
  let response = iterator.getResponse();
  console.log(response.files.length);
  console.log('total search files: ' + iterator.totalSearchFiles());
  console.log('total search pages: ' + iterator.totalSearchPages());
  console.log('current search page: ' + iterator.currentSearchPageIndex());

  // still returns with error since we are on the first page
  iterator.previous()
          .then(() => {})
          .catch((error) => {
            console.error(error);
          });

  iterator.next().then(() => {
    // now previous returns with success since we are on the second page
    iterator.previous().then(() => {
      response = iterator.getResponse();
      console.log(response.files.length);

      // skip the searchFiles results to a particular search results page index
      iterator.skipTo(5).then(() => {
        response = iterator.getResponse();
        console.log(response.files.length);
      });
    });
  });

  // you can create as many iterators as you want for different search queries
  const iterator2 = stock.searchFilesByKeywords(accessToken,
                                      'tree house',
                                      'en-US',
                                      null,
                                      null);

  iterator2.next().then(() => {
    // make sure that you are using correct iterator in the promise resolve methods.
    let response = iterator2.getResponse();
    // let response = iterator.getResponse(); //will return the response from old iterator
    console.log(response.files.length);
    console.log('total search files: ' + iterator2.totalSearchFiles());
    console.log('total search pages: ' + iterator2.totalSearchPages());
    console.log('current search page: ' + iterator2.currentSearchPageIndex());
  });
});

LicenseHistoryIterator

It maintains the current state of licenseHistory responses. Initially, the state is pointed before the first licenseHistory response. The next method moves the state to the next page and fetches its results. The previous and skipTo methods can be used to move one page behind and skip to a particular license history page index respectively. The iterator implements pagination of the results for you.

This class can't be instantiated or constructed on its own. The AdobeStock licenseHistory methods return instances of the SearchFilesIterator class.

Methods

  • The LicenseHistoryIterator class allows you to:
    • totalSearchFiles - Get the total number of license files available. Initially, since the state is pointing before the first response, it returns -1.
    • totalSearchPages - Get the total number of license history pages available. Initially, since the state is pointing before the first response, it returns -1.
    • currentSearchPageIndex - Get the current license history page index of licenseHistory results available from recently performed next or previous or skipTo method invocations. Initially, since the state is pointing before the first response, it returns -1.
    • getResponse - Get the response object of recently performed licenseHistory API call either by using next or previous or skipTo. Initially, this method will return an empty object since it is pointing to before the first licenseHistory response.
    • next - It moves the state to the next page and fetches its results. It returns a promise where it resolves the promise if the licenseHistory API returns successfully and rejects if there is any failure using the licenseHisotry API or if it already hit the last page of results.
    • previous - It moves the state to the previous page and fetches its results. It returns a promise where it resolves the promise if the licenseHistory API returns successfully and rejects if there is any failure using the licenseHistory API, if it already hit the first page of results or if the iterator is pointing before the first licenseHistory response.
    • skipTo - It moves the state to the provided search page and fetches its results. It returns a promise where it resolves the promise if the licenseHistory API returns successfully and rejects if there is any failure using the licenseHistory API or if the provided search page index is out of bounds.
      • Requires:
        • pageIndex - page index to skip to. It is a zero-based index.

Example

const accessToken = 'fdkgnio4isoknzklnvw409jknvzksnvai3289r4209tjaornuivn34nivh3jt340fjvn9304jt';
const queryParams = {
  locale: 'en-US',
  search_parameters: {
    limit: 10,
    offset: 10,
  },
};
const resultColumns = [
  AdobeStock.LICENSE_HISTORY_RESULT_COLUMNS.THUMBNAIL_110_URL,
];
const stock = new AdobeStock('Stock_Client_Api_key', 'Stock Client/1.0.0', AdobeStock.ENVIRONMENT.PROD);
const iterator = stock.licenseHistory(accessToken,
                                  queryParams,
                                  resultColumns);
// returns with error
iterator.previous()
      .then(() => {})
      .catch((error) => {
        console.error(error);
      });

// returns with success
iterator.next().then(() => {
  let response = iterator.getResponse();
  console.log(response.files.length);
  console.log('total search files: ' + iterator.totalSearchFiles());
  console.log('total search pages: ' + iterator.totalSearchPages());
  console.log('current search page: ' + iterator.currentSearchPageIndex());

  // still returns with error since we are on the first page
  iterator.previous()
          .then(() => {})
          .catch((error) => {
            console.error(error);
          });

  iterator.next().then(() => {
    // now previous returns with success since we are on the second page
    iterator.previous().then(() => {
      response = iterator.getResponse();
      console.log(response.files.length);

      // skip the licenseHistory results to a particular license history page index
      iterator.skipTo(5).then(() => {
        response = iterator.getResponse();
        console.log(response.files.length);
      });
    });
  });

Query Parameter Object

In order to simplify the passing of query parameter objects to searchFiles methods, we have mapped the actual URL parameters of the searchFiles API to simpler property names. You can use the below tabular mapping of URL parameters with Query Parameter Property names for creating query parameter objects:

URL Parameter Query Parameter Property Query Parameter Property Key
locale locale AdobeStock.QUERY_PARAMS_PROPS.LOCALE
search_parameters[*] search_parameters AdobeStock.QUERY_PARAMS_PROPS.SEARCH_PARAMETERS
similar_image similar_image AdobeStock.QUERY_PARAMS_PROPS.SIMILAR_IMAGE

The search_parameters properties of the query parameters are themselves objects and they store the corresponding URL parameters as per the following mapping:

URL Parameter search_parameters Property search_parameters Property Key
search_parameters[words] words AdobeStock.SEARCH_PARAMS.WORDS
search_parameters[limit] limit AdobeStock.SEARCH_PARAMS.LIMIT
search_parameters[offset] offset AdobeStock.SEARCH_PARAMS.OFFSET
search_parameters[order] order AdobeStock.SEARCH_PARAMS.ORDER
search_parameters[creator_id] creator_id AdobeStock.SEARCH_PARAMS.CREATOR_ID
search_parameters[media_id] media_id AdobeStock.SEARCH_PARAMS.MEDIA_ID
search_parameters[model_id] model_id AdobeStock.SEARCH_PARAMS.MODEL_ID
search_parameters[serie_id] serie_id AdobeStock.SEARCH_PARAMS.SERIE_ID
search_parameters[gallery_id] gallery_id AdobeStock.SEARCH_PARAMS.GALLERY_ID
search_parameters[similar] similar AdobeStock.SEARCH_PARAMS.SIMILAR
search_parameters[similar_url] similar_url AdobeStock.SEARCH_PARAMS.SIMILAR_URL
search_parameters[similar_image] similar_image AdobeStock.SEARCH_PARAMS.SIMILAR_IMAGE
search_parameters[category] category AdobeStock.SEARCH_PARAMS.CATEGORY
search_parameters[thumbnail_size] thumbnail_size AdobeStock.SEARCH_PARAMS.THUMBNAIL_SIZE
search_parameters[filters][area_pixels] filters_area_pixels AdobeStock.SEARCH_PARAMS.FILTERS_AREA_PIXELS
search_parameters[filters][3d_type_id][] filters_3d_type_id AdobeStock.SEARCH_PARAMS.FILTERS_3D_TYPE_ID
search_parameters[filters][template_type_id][] filters_template_type_id AdobeStock.SEARCH_PARAMS.FILTERS_TEMPLATE_TYPE_ID
search_parameters[filters][template_category_id][] filters_template_category_id AdobeStock.SEARCH_PARAMS.FILTERS_TEMPLATE_CATEGORY_ID
search_parameters[filters][has_releases] filters_has_releases AdobeStock.SEARCH_PARAMS.FILTERS_HAS_RELEASES
search_parameters[filters][content_type:photo] filters_content_type_photo AdobeStock.SEARCH_PARAMS.FILTERS_CONTENT_TYPE_PHOTO
search_parameters[filters][content_type:illustration] filters_content_type_illustration AdobeStock.SEARCH_PARAMS.FILTERS_CONTENT_TYPE_ILLUSTRATION
search_parameters[filters][content_type:vector] filters_content_type_vector AdobeStock.SEARCH_PARAMS.FILTERS_CONTENT_TYPE_VECTOR
search_parameters[filters][content_type:video] filters_content_type_video AdobeStock.SEARCH_PARAMS.FILTERS_CONTENT_TYPE.VIDEO
search_parameters[filters][content_type:3d] filters_content_type_3d AdobeStock.SEARCH_PARAMS.FILTERS_CONTENT_TYPE_3D
search_parameters[filters][content_type:all] filters_content_type_all AdobeStock.SEARCH_PARAMS.FILTERS_CONTENT_TYPE_ALL
search_parameters[filters][offensive:2] filters_offensive_2 AdobeStock.SEARCH_PARAMS.FILTERS_OFFENSIVE_2
search_parameters[filters][isolated:on] filters_isolated_on AdobeStock.SEARCH_PARAMS.FILTERS_ISOLATED_ON
search_parameters[filters][panoramic:on] filters_panoramic_on AdobeStock.SEARCH_PARAMS.FILTERS_PANORAMIC_ON
search_parameters[filters][orientation] filters_orientation AdobeStock.SEARCH_PARAMS.FILTERS_ORIENTATION
search_parameters[filters][age] filters_age AdobeStock.SEARCH_PARAMS.FILTERS_AGE
search_parameters[filters][video_duration] filters_video_duration AdobeStock.SEARCH_PARAMS.FILTERS_VIDEO_DURATION
search_parameters[filters][colors] filters_colors AdobeStock.SEARCH_PARAMS.FILTERS_COLORS
search_parameters[filters][premium] filters_premium AdobeStock.SEARCH_PARAMS.FILTERS_PREMIUM

Example:

const queryParams = {
  locale: 'en-US',
  search_parameters: {
    words: 'tree house',
    media_id: 123324324,
    filters_content_type_photo: 1,
    filters_age: AdobeStock.SEARCH_PARAMS_AGE.TWO_YEAR,
    filters_template_category_id: [
      AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
      AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.MOBILE,
    ],
    similar_image: 1,
  },
  similar_image: File,
}

or

const queryParams = {};
const qProps = AdobeStock.QUERY_PARAMS_PROPS;
queryParams[qProps.LOCALE] = 'en-US';
queryParams[qProps.SIMILAR_IMAGE] = File;

const searchParams = {};
const sProps = AdobeStock.SEARCH_PARAMS;
searchParams[sProps.WORDS] = 'tree house';
searchParams[sProps.MEDIA_ID] = 123324324;
searchParams[sProps.FILTERS_CONTENT_TYPE_PHOTO] = 1;
searchParams[sProps.FILTERS_AGE] = AdobeStock.SEARCH_PARAMS_AGE.TWO_YEAR;
searchParams[sProps.FILTERS_TEMPLATE_TYPE_ID] = [
  AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.PHOTO,
  AdobeStock.SEARCH_PARAMS_TEMPLATE_CATEGORIES.MOBILE,
];

queryParams[qProps.SEARCH_PARAMETERS] = searchParams;

Result Columns

The AdobeStock API allows you to access the list of result columns which can be used to create result columns array. For e.g.

const resultColumns = [
  AdobeStock.RESULT_COLUMNS.ID,
  AdobeStock.RESULT_COLUMNS.TITLE,
  AdobeStock.RESULT_COLUMNS.THUMBNAIL_URL,
  AdobeStock.RESULT_COLUMNS.WIDTH,
  AdobeStock.RESULT_COLUMNS.HEIGHT,
  AdobeStock.RESULT_COLUMNS.CREATION_DATE,
  AdobeStock.RESULT_COLUMNS.KEYWORDS,
];

License State

The AdobeStock API defines various licensing states for the asset. They are accessible on the AdobeStock object. For e.g.

const LICENSE_STATE_PARAMS = {
  EMPTY: {
    EMPTY_LICENSE: '',
  },
  IMAGE: {
    STANDARD: 'standard',
    STANDARD_M: 'standard_m',
    EXTENDED: 'extended',
  },
  VIDEO: {
    VIDEO_HD: 'video_hd',
    VIDEO_4K: 'video_4k',
  },
  VECTOR_ASSETS: {
    STANDARD: 'standard',
    EXTENDED: 'extended',
  },
  ASSETS_3D: {
    STANDARD: 'standard',
  },
  TEMPLATES: {
    STANDARD: 'standard',
  },
};

Purchase State

The AdobeStock API defines various user's purchase relationship to an asset. They are accessible on AdobeStock object. For e.g.

const PURCHASE_STATE_PARAMS = {
  NOT_PURCHASED: 'not_purchased',
  PURCHASED: 'purchased',
  CANCELLED: 'cancelled',
  NOT_POSSIBLE: 'not_possible',
  JUST_PURCHASED: 'just_purchased',
  OVERAGE: 'overage',
};