pinterest_sdk 1.1.0 → 2.1.0

data/lib/pinterest_sdk/api/ads_api.rb

@@ -0,0 +1,1086 @@
+=begin
+#Pinterest REST API
+
+#Pinterest's REST API
+
+The version of the OpenAPI document: 5.28.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module PinterestSdkClient
+  class AdsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create ad preview with pin or image
+    # Create an ad preview given an ad account ID and either an existing organic pin ID or the URL for an image to be used to create the Pin and the ad.  If you are creating a preview from an existing Pin, that Pin must be promotable: that is, it must have a clickthrough link and meet other requirements. (See [Ads Overview](https://help.pinterest.com/en/business/article/promoted-pins-overview).)  You can view the returned preview URL on a webpage or iframe for 7 days, after which the URL expires. Collection ads are not currently supported ad preview.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_preview_request [AdPreviewRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AdPreviewURLResponse]
+    def ad_previews_create(ad_account_id, ad_preview_request, opts = {})
+      data, _status_code, _headers = ad_previews_create_with_http_info(ad_account_id, ad_preview_request, opts)
+      data
+    end
+
+    # Create ad preview with pin or image
+    # Create an ad preview given an ad account ID and either an existing organic pin ID or the URL for an image to be used to create the Pin and the ad.  If you are creating a preview from an existing Pin, that Pin must be promotable: that is, it must have a clickthrough link and meet other requirements. (See [Ads Overview](https://help.pinterest.com/en/business/article/promoted-pins-overview).)  You can view the returned preview URL on a webpage or iframe for 7 days, after which the URL expires. Collection ads are not currently supported ad preview.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_preview_request [AdPreviewRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AdPreviewURLResponse, Integer, Hash)>] AdPreviewURLResponse data, response status code and response headers
+    def ad_previews_create_with_http_info(ad_account_id, ad_preview_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ad_previews_create ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ad_previews_create"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ad_previews_create, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ad_previews_create, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'ad_preview_request' is set
+      if @api_client.config.client_side_validation && ad_preview_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_preview_request' when calling AdsApi.ad_previews_create"
+      end
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ad_previews'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ad_preview_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdPreviewURLResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ad_previews_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ad_previews_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get targeting analytics for ads
+    # Get targeting analytics for one or more ads. For the requested ad(s) and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \"age_bucket\") for applicable values (e.g. \"45-49\").  * The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. * If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. * If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_ids [Array<String>] List of Ad Ids to use to filter the results.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param targeting_types [Array<AdsAnalyticsAdTargetingType>] Targeting type breakdowns for the report. The reporting per targeting type is independent from each other. [\&quot;AGE_BUCKET_AND_GENDER\&quot;] is in BETA and not yet available to all users.
+    # @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.  For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).  If a column has no value, it may not be returned.
+    # @param granularity [Granularity]   TOTAL - metrics are aggregated over the specified date range.    DAY - metrics are broken down daily.    HOUR - metrics are broken down hourly.    WEEK - metrics are broken down weekly.    MONTH - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [ConversionAttributionWindowDays] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.
+    # @option opts [ConversionAttributionWindowDays] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.  **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**.
+    # @option opts [ConversionAttributionWindowDays] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day.
+    # @option opts [ConversionReportTimeType] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.
+    # @option opts [Array<ConversionReportAttributionType>] :attribution_types List of types of attribution for the conversion report
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @option opts [Array<String>] :sort_columns Sort Columns.
+    # @option opts [Boolean] :sort_ascending Sort ascending.
+    # @return [MetricsResponse]
+    def ad_targeting_analytics_get(ad_account_id, ad_ids, start_date, end_date, targeting_types, columns, granularity, opts = {})
+      data, _status_code, _headers = ad_targeting_analytics_get_with_http_info(ad_account_id, ad_ids, start_date, end_date, targeting_types, columns, granularity, opts)
+      data
+    end
+
+    # Get targeting analytics for ads
+    # Get targeting analytics for one or more ads. For the requested ad(s) and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. \&quot;age_bucket\&quot;) for applicable values (e.g. \&quot;45-49\&quot;).  * The token&#39;s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager. * If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days. * If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_ids [Array<String>] List of Ad Ids to use to filter the results.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param targeting_types [Array<AdsAnalyticsAdTargetingType>] Targeting type breakdowns for the report. The reporting per targeting type is independent from each other. [\&quot;AGE_BUCKET_AND_GENDER\&quot;] is in BETA and not yet available to all users.
+    # @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.  For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).  If a column has no value, it may not be returned.
+    # @param granularity [Granularity]   TOTAL - metrics are aggregated over the specified date range.    DAY - metrics are broken down daily.    HOUR - metrics are broken down hourly.    WEEK - metrics are broken down weekly.    MONTH - metrics are broken down monthly
+    # @param [Hash] opts the optional parameters
+    # @option opts [ConversionAttributionWindowDays] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.
+    # @option opts [ConversionAttributionWindowDays] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days.  **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**.
+    # @option opts [ConversionAttributionWindowDays] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day.
+    # @option opts [ConversionReportTimeType] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.
+    # @option opts [Array<ConversionReportAttributionType>] :attribution_types List of types of attribution for the conversion report
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @option opts [Array<String>] :sort_columns Sort Columns.
+    # @option opts [Boolean] :sort_ascending Sort ascending.
+    # @return [Array<(MetricsResponse, Integer, Hash)>] MetricsResponse data, response status code and response headers
+    def ad_targeting_analytics_get_with_http_info(ad_account_id, ad_ids, start_date, end_date, targeting_types, columns, granularity, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ad_targeting_analytics_get ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ad_targeting_analytics_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ad_targeting_analytics_get, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'ad_ids' is set
+      if @api_client.config.client_side_validation && ad_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_ids' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && ad_ids.length > 250
+        fail ArgumentError, 'invalid value for "ad_ids" when calling AdsApi.ad_targeting_analytics_get, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && ad_ids.length < 1
+        fail ArgumentError, 'invalid value for "ad_ids" when calling AdsApi.ad_targeting_analytics_get, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'start_date' is set
+      if @api_client.config.client_side_validation && start_date.nil?
+        fail ArgumentError, "Missing the required parameter 'start_date' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      # verify the required parameter 'end_date' is set
+      if @api_client.config.client_side_validation && end_date.nil?
+        fail ArgumentError, "Missing the required parameter 'end_date' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      # verify the required parameter 'targeting_types' is set
+      if @api_client.config.client_side_validation && targeting_types.nil?
+        fail ArgumentError, "Missing the required parameter 'targeting_types' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && targeting_types.length > 14
+        fail ArgumentError, 'invalid value for "targeting_types" when calling AdsApi.ad_targeting_analytics_get, number of items must be less than or equal to 14.'
+      end
+
+      if @api_client.config.client_side_validation && targeting_types.length < 1
+        fail ArgumentError, 'invalid value for "targeting_types" when calling AdsApi.ad_targeting_analytics_get, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'columns' is set
+      if @api_client.config.client_side_validation && columns.nil?
+        fail ArgumentError, "Missing the required parameter 'columns' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      # verify the required parameter 'granularity' is set
+      if @api_client.config.client_side_validation && granularity.nil?
+        fail ArgumentError, "Missing the required parameter 'granularity' when calling AdsApi.ad_targeting_analytics_get"
+      end
+      if @api_client.config.client_side_validation && !opts[:'attribution_types'].nil? && opts[:'attribution_types'].length > 2
+        fail ArgumentError, 'invalid value for "opts[:"attribution_types"]" when calling AdsApi.ad_targeting_analytics_get, number of items must be less than or equal to 2.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'sort_columns'].nil? && opts[:'sort_columns'].length > 2
+        fail ArgumentError, 'invalid value for "opts[:"sort_columns"]" when calling AdsApi.ad_targeting_analytics_get, number of items must be less than or equal to 2.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'sort_columns'].nil? && opts[:'sort_columns'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"sort_columns"]" when calling AdsApi.ad_targeting_analytics_get, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ads/targeting_analytics'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_ids'] = @api_client.build_collection_param(ad_ids, :multi)
+      query_params[:'start_date'] = start_date
+      query_params[:'end_date'] = end_date
+      query_params[:'targeting_types'] = @api_client.build_collection_param(targeting_types, :csv)
+      query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
+      query_params[:'granularity'] = granularity
+      query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
+      query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
+      query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
+      query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
+      query_params[:'attribution_types'] = @api_client.build_collection_param(opts[:'attribution_types'], :csv) if !opts[:'attribution_types'].nil?
+      query_params[:'reporting_timezone'] = opts[:'reporting_timezone'] if !opts[:'reporting_timezone'].nil?
+      query_params[:'sort_columns'] = @api_client.build_collection_param(opts[:'sort_columns'], :multi) if !opts[:'sort_columns'].nil?
+      query_params[:'sort_ascending'] = opts[:'sort_ascending'] if !opts[:'sort_ascending'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetricsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ad_targeting_analytics_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ad_targeting_analytics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get ad analytics
+    #     Get analytics for the specified ads in the specified `ad_account_id`, filtered by the specified options.     - The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager.     - The request must contain either ad_ids or both campaign_ids and pin_ids.     - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days.     - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.  For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).  If a column has no value, it may not be returned.
+    # @param granularity [Granularity]   TOTAL - metrics are aggregated over the specified date range.    DAY - metrics are broken down daily.    HOUR - metrics are broken down hourly.    WEEK - metrics are broken down weekly.    MONTH - metrics are broken down monthly
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :pin_ids List of Pin IDs.
+    # @option opts [Array<String>] :ad_ids List of Ad Ids to use to filter the results.
+    # @option opts [Float] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Float] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**. (default to 30)
+    # @option opts [Float] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @option opts [Array<String>] :campaign_ids List of Campaign Ids to use to filter the results.
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @return [Array<AdsAnalytics>]
+    def ads_analytics(start_date, end_date, columns, granularity, ad_account_id, opts = {})
+      data, _status_code, _headers = ads_analytics_with_http_info(start_date, end_date, columns, granularity, ad_account_id, opts)
+      data
+    end
+
+    # Get ad analytics
+    #     Get analytics for the specified ads in the specified &#x60;ad_account_id&#x60;, filtered by the specified options.     - The token&#39;s user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via [Business Access](https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts): Admin, Analyst, Campaign Manager.     - The request must contain either ad_ids or both campaign_ids and pin_ids.     - If granularity is not HOUR, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days.     - If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
+    # @param start_date [Date] Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
+    # @param end_date [Date] Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
+    # @param columns [Array<ReportingColumnSync>] Columns to retrieve, encoded as a comma-separated string. **NOTE**: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile&#39;s currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it&#39;s microdollars. Otherwise, it&#39;s in microunits of the advertiser&#39;s currency.  For example, if the advertiser&#39;s currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).  If a column has no value, it may not be returned.
+    # @param granularity [Granularity]   TOTAL - metrics are aggregated over the specified date range.    DAY - metrics are broken down daily.    HOUR - metrics are broken down hourly.    WEEK - metrics are broken down weekly.    MONTH - metrics are broken down monthly
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :pin_ids List of Pin IDs.
+    # @option opts [Array<String>] :ad_ids List of Ad Ids to use to filter the results.
+    # @option opts [Float] :click_window_days Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. (default to 30)
+    # @option opts [Float] :engagement_window_days Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;30&#x60; days. **Note:** This parameter no longer returns new data. However, you can still access historic data through **Sept 30, 2027**. (default to 30)
+    # @option opts [Float] :view_window_days Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to &#x60;1&#x60; day. (default to 1)
+    # @option opts [String] :conversion_report_time The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event. (default to 'TIME_OF_AD_ACTION')
+    # @option opts [Array<String>] :campaign_ids List of Campaign Ids to use to filter the results.
+    # @option opts [ReportingTimeZone] :reporting_timezone Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.
+    # @return [Array<(Array<AdsAnalytics>, Integer, Hash)>] Array<AdsAnalytics> data, response status code and response headers
+    def ads_analytics_with_http_info(start_date, end_date, columns, granularity, ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ads_analytics ...'
+      end
+      # verify the required parameter 'start_date' is set
+      if @api_client.config.client_side_validation && start_date.nil?
+        fail ArgumentError, "Missing the required parameter 'start_date' when calling AdsApi.ads_analytics"
+      end
+      # verify the required parameter 'end_date' is set
+      if @api_client.config.client_side_validation && end_date.nil?
+        fail ArgumentError, "Missing the required parameter 'end_date' when calling AdsApi.ads_analytics"
+      end
+      # verify the required parameter 'columns' is set
+      if @api_client.config.client_side_validation && columns.nil?
+        fail ArgumentError, "Missing the required parameter 'columns' when calling AdsApi.ads_analytics"
+      end
+      # verify the required parameter 'granularity' is set
+      if @api_client.config.client_side_validation && granularity.nil?
+        fail ArgumentError, "Missing the required parameter 'granularity' when calling AdsApi.ads_analytics"
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ads_analytics"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ads_analytics, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ads_analytics, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'pin_ids'].nil? && opts[:'pin_ids'].length > 100
+        fail ArgumentError, 'invalid value for "opts[:"pin_ids"]" when calling AdsApi.ads_analytics, number of items must be less than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'pin_ids'].nil? && opts[:'pin_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"pin_ids"]" when calling AdsApi.ads_analytics, number of items must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_ids'].nil? && opts[:'ad_ids'].length > 250
+        fail ArgumentError, 'invalid value for "opts[:"ad_ids"]" when calling AdsApi.ads_analytics, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_ids'].nil? && opts[:'ad_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"ad_ids"]" when calling AdsApi.ads_analytics, number of items must be greater than or equal to 1.'
+      end
+
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'click_window_days'] && !allowable_values.include?(opts[:'click_window_days'])
+        fail ArgumentError, "invalid value for \"click_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'engagement_window_days'] && !allowable_values.include?(opts[:'engagement_window_days'])
+        fail ArgumentError, "invalid value for \"engagement_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = [0, 1, 7, 14, 30, 60]
+      if @api_client.config.client_side_validation && opts[:'view_window_days'] && !allowable_values.include?(opts[:'view_window_days'])
+        fail ArgumentError, "invalid value for \"view_window_days\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["TIME_OF_AD_ACTION", "TIME_OF_CONVERSION"]
+      if @api_client.config.client_side_validation && opts[:'conversion_report_time'] && !allowable_values.include?(opts[:'conversion_report_time'])
+        fail ArgumentError, "invalid value for \"conversion_report_time\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'campaign_ids'].nil? && opts[:'campaign_ids'].length > 250
+        fail ArgumentError, 'invalid value for "opts[:"campaign_ids"]" when calling AdsApi.ads_analytics, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'campaign_ids'].nil? && opts[:'campaign_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"campaign_ids"]" when calling AdsApi.ads_analytics, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ads/analytics'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_date'] = start_date
+      query_params[:'end_date'] = end_date
+      query_params[:'columns'] = @api_client.build_collection_param(columns, :csv)
+      query_params[:'granularity'] = granularity
+      query_params[:'pin_ids'] = @api_client.build_collection_param(opts[:'pin_ids'], :multi) if !opts[:'pin_ids'].nil?
+      query_params[:'ad_ids'] = @api_client.build_collection_param(opts[:'ad_ids'], :multi) if !opts[:'ad_ids'].nil?
+      query_params[:'click_window_days'] = opts[:'click_window_days'] if !opts[:'click_window_days'].nil?
+      query_params[:'engagement_window_days'] = opts[:'engagement_window_days'] if !opts[:'engagement_window_days'].nil?
+      query_params[:'view_window_days'] = opts[:'view_window_days'] if !opts[:'view_window_days'].nil?
+      query_params[:'conversion_report_time'] = opts[:'conversion_report_time'] if !opts[:'conversion_report_time'].nil?
+      query_params[:'campaign_ids'] = @api_client.build_collection_param(opts[:'campaign_ids'], :multi) if !opts[:'campaign_ids'].nil?
+      query_params[:'reporting_timezone'] = opts[:'reporting_timezone'] if !opts[:'reporting_timezone'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AdsAnalytics>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ads_analytics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ads_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create ads
+    # Create multiple new ads. Request must contain ad_group_id, creative_type, and the source Pin pin_id.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_create [Array<AdCreate>] 
+    # @param [Hash] opts the optional parameters
+    # @return [AdBatchWriteResponseModel]
+    def ads_create(ad_account_id, ad_create, opts = {})
+      data, _status_code, _headers = ads_create_with_http_info(ad_account_id, ad_create, opts)
+      data
+    end
+
+    # Create ads
+    # Create multiple new ads. Request must contain ad_group_id, creative_type, and the source Pin pin_id.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_create [Array<AdCreate>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AdBatchWriteResponseModel, Integer, Hash)>] AdBatchWriteResponseModel data, response status code and response headers
+    def ads_create_with_http_info(ad_account_id, ad_create, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ads_create ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ads_create"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ads_create, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ads_create, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'ad_create' is set
+      if @api_client.config.client_side_validation && ad_create.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_create' when calling AdsApi.ads_create"
+      end
+      if @api_client.config.client_side_validation && ad_create.length > 30
+        fail ArgumentError, 'invalid value for "ad_create" when calling AdsApi.ads_create, number of items must be less than or equal to 30.'
+      end
+
+      if @api_client.config.client_side_validation && ad_create.length < 1
+        fail ArgumentError, 'invalid value for "ad_create" when calling AdsApi.ads_create, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ads'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ad_create)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdBatchWriteResponseModel'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ads_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ads_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get ad
+    # Get a specific ad given the ad ID. If your pin is rejected, rejected_reasons will contain additional information from the Ad Review process. For more information about our policies and rejection reasons see the [Pinterest advertising standards](https://www.pinterest.com/_/_/policy/advertising-guidelines/).
+    # @param ad_id [String] The ID of this ad.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @return [Ad]
+    def ads_get(ad_id, ad_account_id, opts = {})
+      data, _status_code, _headers = ads_get_with_http_info(ad_id, ad_account_id, opts)
+      data
+    end
+
+    # Get ad
+    # Get a specific ad given the ad ID. If your pin is rejected, rejected_reasons will contain additional information from the Ad Review process. For more information about our policies and rejection reasons see the [Pinterest advertising standards](https://www.pinterest.com/_/_/policy/advertising-guidelines/).
+    # @param ad_id [String] The ID of this ad.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ad, Integer, Hash)>] Ad data, response status code and response headers
+    def ads_get_with_http_info(ad_id, ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ads_get ...'
+      end
+      # verify the required parameter 'ad_id' is set
+      if @api_client.config.client_side_validation && ad_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_id' when calling AdsApi.ads_get"
+      end
+      if @api_client.config.client_side_validation && ad_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_id" when calling AdsApi.ads_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_id' when calling AdsApi.ads_get, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ads_get"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ads_get, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ads_get, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ads/{ad_id}'.sub('{ad_id}', CGI.escape(ad_id.to_s)).sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Ad'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ads_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ads_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List ads
+    # List ads that meet the filters provided:     - Listed campaign ids or ad group ids or ad ids     - Listed entity statuses  If no filter is provided, all ads in the ad account are returned.  **Note:** Provide only `campaign_id` or `ad_group_id` or `ad_id`. Do not provide more than one type.  Review status is provided for each ad; if `review_status` is `REJECTED`, the `rejected_reasons` field will contain additional information.  For more, see [Pinterest advertising standards](https://policy.pinterest.com/en/advertising-guidelines).
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @option opts [PinterestLibPaginationOrder] :order The order in which to sort the items returned: \&quot;ASCENDING\&quot; or \&quot;DESCENDING\&quot; by ID. Note that higher-value IDs are associated with more-recently added items.
+    # @option opts [Array<String>] :campaign_ids List of Campaign Ids to use to filter the results.
+    # @option opts [Array<String>] :ad_group_ids List of Ad group Ids to retrieve keywords from. This feature is currently in BETA and is not available to all users.
+    # @option opts [Array<String>] :ad_ids List of Ad Ids to use to filter the results.
+    # @option opts [Array<EntityStatus>] :entity_statuses Entity status
+    # @return [AdsList200Response]
+    def ads_list(ad_account_id, opts = {})
+      data, _status_code, _headers = ads_list_with_http_info(ad_account_id, opts)
+      data
+    end
+
+    # List ads
+    # List ads that meet the filters provided:     - Listed campaign ids or ad group ids or ad ids     - Listed entity statuses  If no filter is provided, all ads in the ad account are returned.  **Note:** Provide only &#x60;campaign_id&#x60; or &#x60;ad_group_id&#x60; or &#x60;ad_id&#x60;. Do not provide more than one type.  Review status is provided for each ad; if &#x60;review_status&#x60; is &#x60;REJECTED&#x60;, the &#x60;rejected_reasons&#x60; field will contain additional information.  For more, see [Pinterest advertising standards](https://policy.pinterest.com/en/advertising-guidelines).
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :bookmark Cursor used to fetch the next page of items
+    # @option opts [Integer] :page_size Maximum number of items to include in a single page. See documentation on [Pagination](/docs/reference/pagination/) for more information. (default to 25)
+    # @option opts [PinterestLibPaginationOrder] :order The order in which to sort the items returned: \&quot;ASCENDING\&quot; or \&quot;DESCENDING\&quot; by ID. Note that higher-value IDs are associated with more-recently added items.
+    # @option opts [Array<String>] :campaign_ids List of Campaign Ids to use to filter the results.
+    # @option opts [Array<String>] :ad_group_ids List of Ad group Ids to retrieve keywords from. This feature is currently in BETA and is not available to all users.
+    # @option opts [Array<String>] :ad_ids List of Ad Ids to use to filter the results.
+    # @option opts [Array<EntityStatus>] :entity_statuses Entity status
+    # @return [Array<(AdsList200Response, Integer, Hash)>] AdsList200Response data, response status code and response headers
+    def ads_list_with_http_info(ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ads_list ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ads_list"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ads_list, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ads_list, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdsApi.ads_list, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AdsApi.ads_list, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'campaign_ids'].nil? && opts[:'campaign_ids'].length > 250
+        fail ArgumentError, 'invalid value for "opts[:"campaign_ids"]" when calling AdsApi.ads_list, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'campaign_ids'].nil? && opts[:'campaign_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"campaign_ids"]" when calling AdsApi.ads_list, number of items must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_group_ids'].nil? && opts[:'ad_group_ids'].length > 250
+        fail ArgumentError, 'invalid value for "opts[:"ad_group_ids"]" when calling AdsApi.ads_list, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_group_ids'].nil? && opts[:'ad_group_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"ad_group_ids"]" when calling AdsApi.ads_list, number of items must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_ids'].nil? && opts[:'ad_ids'].length > 250
+        fail ArgumentError, 'invalid value for "opts[:"ad_ids"]" when calling AdsApi.ads_list, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_ids'].nil? && opts[:'ad_ids'].length < 1
+        fail ArgumentError, 'invalid value for "opts[:"ad_ids"]" when calling AdsApi.ads_list, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ads'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
+      query_params[:'campaign_ids'] = @api_client.build_collection_param(opts[:'campaign_ids'], :multi) if !opts[:'campaign_ids'].nil?
+      query_params[:'ad_group_ids'] = @api_client.build_collection_param(opts[:'ad_group_ids'], :multi) if !opts[:'ad_group_ids'].nil?
+      query_params[:'ad_ids'] = @api_client.build_collection_param(opts[:'ad_ids'], :multi) if !opts[:'ad_ids'].nil?
+      query_params[:'entity_statuses'] = @api_client.build_collection_param(opts[:'entity_statuses'], :multi) if !opts[:'entity_statuses'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdsList200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ads_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ads_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update ads
+    # Update multiple existing ads
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_batch_update [Array<AdBatchUpdate>] 
+    # @param [Hash] opts the optional parameters
+    # @return [AdBatchWriteResponseModel]
+    def ads_update(ad_account_id, ad_batch_update, opts = {})
+      data, _status_code, _headers = ads_update_with_http_info(ad_account_id, ad_batch_update, opts)
+      data
+    end
+
+    # Update ads
+    # Update multiple existing ads
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param ad_batch_update [Array<AdBatchUpdate>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AdBatchWriteResponseModel, Integer, Hash)>] AdBatchWriteResponseModel data, response status code and response headers
+    def ads_update_with_http_info(ad_account_id, ad_batch_update, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.ads_update ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.ads_update"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.ads_update, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.ads_update, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'ad_batch_update' is set
+      if @api_client.config.client_side_validation && ad_batch_update.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_batch_update' when calling AdsApi.ads_update"
+      end
+      if @api_client.config.client_side_validation && ad_batch_update.length > 30
+        fail ArgumentError, 'invalid value for "ad_batch_update" when calling AdsApi.ads_update, number of items must be less than or equal to 30.'
+      end
+
+      if @api_client.config.client_side_validation && ad_batch_update.length < 1
+        fail ArgumentError, 'invalid value for "ad_batch_update" when calling AdsApi.ads_update, number of items must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/ads'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(ad_batch_update)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdBatchWriteResponseModel'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.ads_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#ads_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create ad preview records for one or more ad groups
+    # Create ad preview records for one or more ad groups that can be shared. Each ad group is processed independently; individual failures do not block other previews.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_ad_preview_create [Array<CampaignAdPreviewCreate>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<CampaignAdPreviewCreate200ResponseInner>]
+    def campaign_ad_preview_create(ad_account_id, campaign_ad_preview_create, opts = {})
+      data, _status_code, _headers = campaign_ad_preview_create_with_http_info(ad_account_id, campaign_ad_preview_create, opts)
+      data
+    end
+
+    # Create ad preview records for one or more ad groups
+    # Create ad preview records for one or more ad groups that can be shared. Each ad group is processed independently; individual failures do not block other previews.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param campaign_ad_preview_create [Array<CampaignAdPreviewCreate>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<CampaignAdPreviewCreate200ResponseInner>, Integer, Hash)>] Array<CampaignAdPreviewCreate200ResponseInner> data, response status code and response headers
+    def campaign_ad_preview_create_with_http_info(ad_account_id, campaign_ad_preview_create, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.campaign_ad_preview_create ...'
+      end
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.campaign_ad_preview_create"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.campaign_ad_preview_create, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.campaign_ad_preview_create, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'campaign_ad_preview_create' is set
+      if @api_client.config.client_side_validation && campaign_ad_preview_create.nil?
+        fail ArgumentError, "Missing the required parameter 'campaign_ad_preview_create' when calling AdsApi.campaign_ad_preview_create"
+      end
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaign_ad_preview'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_ad_preview_create)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CampaignAdPreviewCreate200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.campaign_ad_preview_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#campaign_ad_preview_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete ad preview records for one or more ad groups
+    # Delete ad preview records for one or more ad groups. All ad groups are validated before deleting any records.
+    # @param ad_group_ids [Array<String>] List of Ad group Ids to use to filter the results.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<CampaignAdPreviewDelete200ResponseInner>]
+    def campaign_ad_preview_delete(ad_group_ids, ad_account_id, opts = {})
+      data, _status_code, _headers = campaign_ad_preview_delete_with_http_info(ad_group_ids, ad_account_id, opts)
+      data
+    end
+
+    # Delete ad preview records for one or more ad groups
+    # Delete ad preview records for one or more ad groups. All ad groups are validated before deleting any records.
+    # @param ad_group_ids [Array<String>] List of Ad group Ids to use to filter the results.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<CampaignAdPreviewDelete200ResponseInner>, Integer, Hash)>] Array<CampaignAdPreviewDelete200ResponseInner> data, response status code and response headers
+    def campaign_ad_preview_delete_with_http_info(ad_group_ids, ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.campaign_ad_preview_delete ...'
+      end
+      # verify the required parameter 'ad_group_ids' is set
+      if @api_client.config.client_side_validation && ad_group_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_group_ids' when calling AdsApi.campaign_ad_preview_delete"
+      end
+      if @api_client.config.client_side_validation && ad_group_ids.length > 250
+        fail ArgumentError, 'invalid value for "ad_group_ids" when calling AdsApi.campaign_ad_preview_delete, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && ad_group_ids.length < 1
+        fail ArgumentError, 'invalid value for "ad_group_ids" when calling AdsApi.campaign_ad_preview_delete, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.campaign_ad_preview_delete"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.campaign_ad_preview_delete, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.campaign_ad_preview_delete, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaign_ad_preview'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_group_ids'] = @api_client.build_collection_param(ad_group_ids, :multi)
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CampaignAdPreviewDelete200ResponseInner>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.campaign_ad_preview_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#campaign_ad_preview_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch ad preview records for one or more ad groups
+    # Fetch ad preview records for one or more ad groups. Returns all active previews associated with the provided ad group IDs.
+    # @param ad_group_ids [Array<String>] List of Ad group Ids to use to filter the results.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<CampaignAdPreview>]
+    def campaign_ad_preview_read(ad_group_ids, ad_account_id, opts = {})
+      data, _status_code, _headers = campaign_ad_preview_read_with_http_info(ad_group_ids, ad_account_id, opts)
+      data
+    end
+
+    # Fetch ad preview records for one or more ad groups
+    # Fetch ad preview records for one or more ad groups. Returns all active previews associated with the provided ad group IDs.
+    # @param ad_group_ids [Array<String>] List of Ad group Ids to use to filter the results.
+    # @param ad_account_id [String] Unique identifier of an ad account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<CampaignAdPreview>, Integer, Hash)>] Array<CampaignAdPreview> data, response status code and response headers
+    def campaign_ad_preview_read_with_http_info(ad_group_ids, ad_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdsApi.campaign_ad_preview_read ...'
+      end
+      # verify the required parameter 'ad_group_ids' is set
+      if @api_client.config.client_side_validation && ad_group_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_group_ids' when calling AdsApi.campaign_ad_preview_read"
+      end
+      if @api_client.config.client_side_validation && ad_group_ids.length > 250
+        fail ArgumentError, 'invalid value for "ad_group_ids" when calling AdsApi.campaign_ad_preview_read, number of items must be less than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && ad_group_ids.length < 1
+        fail ArgumentError, 'invalid value for "ad_group_ids" when calling AdsApi.campaign_ad_preview_read, number of items must be greater than or equal to 1.'
+      end
+
+      # verify the required parameter 'ad_account_id' is set
+      if @api_client.config.client_side_validation && ad_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling AdsApi.campaign_ad_preview_read"
+      end
+      if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18
+        fail ArgumentError, 'invalid value for "ad_account_id" when calling AdsApi.campaign_ad_preview_read, the character length must be smaller than or equal to 18.'
+      end
+
+      pattern = Regexp.new(/^\d+$/)
+      if @api_client.config.client_side_validation && ad_account_id !~ pattern
+        fail ArgumentError, "invalid value for 'ad_account_id' when calling AdsApi.campaign_ad_preview_read, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/ad_accounts/{ad_account_id}/campaign_ad_preview'.sub('{ad_account_id}', CGI.escape(ad_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ad_group_ids'] = @api_client.build_collection_param(ad_group_ids, :multi)
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<CampaignAdPreview>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AdsApi.campaign_ad_preview_read",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdsApi#campaign_ad_preview_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end