Amazon Ads API MCP

{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{"advertiserIdHeader":{"description":"The identifier that describe DSP advertiser level accounts that exists under a manager account (previously under a DSP entity). Exposed in the /dsp/advertisers API.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},"clientHeader":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},"profileHeader":{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.","in":"header","name":"Amazon-Advertising-API-Scope","required":false,"schema":{"type":"string"}}},"requestBodies":{},"responses":{},"schemas":{"AdTypeV1":{"description":"Supported values are DSP(Demand Side Platform).","enum":["DSP"],"readOnly":true,"type":"string"},"AssetTypeV1M2":{"description":"The type of the Asset.","enum":["IMAGE","VIDEO"],"readOnly":true,"type":"string"},"AssetV1M2":{"description":"The Amazon Creative Asset Library asset identifier. Refer https://advertising.amazon.com/API/docs/en-us/creative-asset-library","properties":{"assetId":{"description":"The assetId.","type":"string"},"assetType":{"$ref":"#/components/schemas/AssetTypeV1M2"},"version":{"description":"The version of the asset.","type":"string"}}},"AudienceGroupV1M2":{"description":"The model for holding Audiece selection within a group. The expression within an audience group will be evaluated using the IntraGroupOperator. The InterGroupOperator will be applied on the output of one audience group with another audience group.","properties":{"audienceSegments":{"description":"List of audience segments in this group.","items":{"$ref":"#/components/schemas/AudienceSegmentV1M2"},"maxItems":100,"minItems":0,"type":"array"},"interGroupOperator":{"$ref":"#/components/schemas/AudienceSelectionOperatorV1M2"},"intraGroupOperator":{"$ref":"#/components/schemas/AudienceSelectionOperatorV1M2"}},"type":"object"},"AudienceResearchStudyResultV1M2":{"description":"The result of Audience Research study.","properties":{"studyId":{"description":"The canonical Id of Study.","type":"string"},"surveyResponses":{"description":"Detailed response rate for each response in Survey question aggregated by different segments.","items":{"$ref":"#/components/schemas/SurveyResponseResultV1","properties":{}},"maxItems":2000,"minItems":1,"type":"array"},"totalResponses":{"description":"Total number of responses received in the Survey.","type":"number"}}},"AudienceSegmentV1M2":{"description":"The model for holding an Audience Segment.","properties":{"segmentId":{"description":"ID for the audience segment. This ID can be fetched from these APIs- https://advertising.amazon.com/API/docs/en-us/audiences/#/Discovery","type":"string"}},"type":"object"},"AudienceSelectionOperatorV1M2":{"description":"The operator used in Audience Segment Selection to determine which operation needs to be applied across selected segments. AND operator takes priority over OR operator.","enum":["AND","OR"],"readOnly":true,"type":"string"},"AudienceTargetingGroupV1M2":{"description":"The model for holding Audiece targeting group. The includedAudienceGroups and excludedAudienceGroups are always joined with AND operator.","properties":{"excludedAudienceGroups":{"description":"List of audience groups to be excluded from the targeted audience.","items":{"$ref":"#/components/schemas/AudienceGroupV1M2"},"maxItems":100,"minItems":0,"type":"array"},"includedAudienceGroups":{"description":"List of audience groups to be included in the targeted audience.","items":{"$ref":"#/components/schemas/AudienceGroupV1M2"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"BaseEligibilityRequestV1":{"description":"The request object of measurement eligibility check.","properties":{"fundingTypeFilters":{"description":"FundingType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/FundingTypeV1"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductIdFilters":{"description":"VendorProduct identifier filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"vendorTypeFilters":{"description":"VendorType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/VendorTypeV1"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"BaseEligibilityRequestV1M1":{"description":"The request object of measurement eligibility check.","properties":{"fundingTypeFilters":{"description":"FundingType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/FundingTypeV1M1"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductIdFilters":{"description":"VendorProduct identifier filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"vendorTypeFilters":{"description":"VendorType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/VendorTypeV1M1"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"BaseEligibilityRequestV1M2":{"description":"The request object of measurement eligibility check.","properties":{"fundingTypeFilters":{"description":"FundingType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/FundingTypeV1M2"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductIdFilters":{"description":"VendorProduct identifier filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"vendorTypeFilters":{"description":"VendorType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/VendorTypeV1M2"},"maxItems":100,"minItems":1,"type":"array"}}},"BaseEligibilityRequestV1M3":{"description":"The request object of measurement eligibility check.","properties":{"fundingTypeFilters":{"description":"FundingType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/FundingTypeV1M3"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductIdFilters":{"description":"VendorProduct identifier filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"vendorTypeFilters":{"description":"VendorType filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/VendorTypeV1M3"},"maxItems":100,"minItems":1,"type":"array"}}},"BaseStudyV1":{"description":"The base study object.","properties":{"comment":{"description":"The approver's comment on why the study is approved/rejected.","readOnly":true,"type":"string"},"createDate":{"description":"The study creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"endDate":{"description":"The study end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. By default this will be the latest endDate of the associated orders.","format":"date-time","readOnly":true,"type":"string"},"externalReferenceId":{"description":"Optional field. For some vendors, advertisers are required to provide this vendor assigned reference identifier for EXTERNAL_BILLING studies.","type":"string"},"id":{"description":"The study canonical identifier. Immutable field. This is required for update.","type":"string"},"lastUpdatedDate":{"description":"The study last updated date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The study name.","type":"string"},"rejectionReasons":{"description":"List of reasons for rejection, this will only be available if the status is REJECTED. This field is deprecated, use statusReasons instead.","items":{"type":"string"},"maxItems":100,"minItems":0,"readOnly":true,"type":"array"},"reviewDate":{"description":"The study review date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"startDate":{"description":"The study start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. By default this will be the earliest startDate of the associated orders.","format":"date-time","readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/StudyStatusV1"},"statusReasons":{"description":"List of reasons for study status. For example, when study is marked Rejected or Ineligible, this field would be available.","items":{"type":"string"},"maxItems":100,"minItems":0,"readOnly":true,"type":"array"},"studyResultStatus":{"description":"The status of result of the study.","enum":["AVAILABLE"],"type":"string"},"submissionType":{"$ref":"#/components/schemas/StudySubmissionTypeV1"},"surveyId":{"description":"The study survey canonical identifier.","type":"string"},"vendorProductId":{"description":"Associated vendor product canonical identifier.","type":"string"}},"type":"object"},"BaseStudyV1M1":{"description":"The base study object.","properties":{"comment":{"description":"The approver's comment on why the study is approved/rejected.","readOnly":true,"type":"string"},"createDate":{"description":"The study creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"endDate":{"description":"The study end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. By default this will be the latest endDate of the associated orders.","format":"date-time","readOnly":true,"type":"string"},"externalReferenceId":{"description":"Optional field. For some vendors, advertisers are required to provide this vendor assigned reference identifier for EXTERNAL_BILLING studies.","type":"string"},"id":{"description":"The study canonical identifier. Immutable field. This is required for update.","type":"string"},"lastUpdatedDate":{"description":"The study last updated date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"links":{"items":{"$ref":"#/components/schemas/ResourceLinkV1M1"},"maxItems":100,"minItems":0,"readOnly":true,"type":"array"},"name":{"description":"The study name.","type":"string"},"rejectionReasons":{"description":"List of reasons for rejection, this will only be available if the status is REJECTED. This field is deprecated, use statusReasons instead.","items":{"type":"string"},"maxItems":100,"minItems":0,"readOnly":true,"type":"array"},"reviewDate":{"description":"The study review date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"startDate":{"description":"The study start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. By default this will be the earliest startDate of the associated orders.","format":"date-time","readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/StudyStatusV1"},"statusReasons":{"description":"List of reasons for study status. For example, when study is marked Rejected or Ineligible, this field would be available.","items":{"type":"string"},"maxItems":100,"minItems":0,"readOnly":true,"type":"array"},"studyResultStatus":{"description":"The status of result of the study.","enum":["AVAILABLE"],"type":"string"},"submissionType":{"$ref":"#/components/schemas/StudySubmissionTypeV1"},"surveyId":{"description":"The study survey canonical identifier.","type":"string"},"vendorProductId":{"description":"Associated vendor product canonical identifier.","type":"string"}},"type":"object"},"BaseStudyV1M2":{"description":"The base study object.","properties":{"comment":{"description":"The approver's comment on why the study is approved/rejected.","readOnly":true,"type":"string"},"createDate":{"description":"The study creation date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"endDate":{"description":"The study end date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. By default this will be the latest endDate of the associated orders.","format":"date-time","readOnly":true,"type":"string"},"externalReferenceId":{"description":"Optional field. For some vendors, advertisers are required to provide this vendor assigned reference identifier for EXTERNAL_BILLING studies.","type":"string"},"lastUpdatedDate":{"description":"The study last updated date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The study name.","type":"string"},"reviewDate":{"description":"The study review date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"startDate":{"description":"The study start date in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC. By default this will be the earliest startDate of the associated orders.","format":"date-time","readOnly":true,"type":"string"},"status":{"$ref":"#/components/schemas/StudyStatusV1"},"statusReasons":{"description":"List of reasons for study status. For example, when study is marked Rejected or Ineligible, this field would be available.","items":{"type":"string"},"maxItems":100,"minItems":0,"readOnly":true,"type":"array"},"studyResultStatus":{"description":"The status of result of the study.","enum":["AVAILABLE"],"type":"string"},"surveyId":{"description":"The study survey canonical identifier.","type":"string"},"vendorProductId":{"description":"Associated vendor product canonical identifier.","type":"string"}},"type":"object"},"BenchmarkCategoryV1":{"description":"The study benchmark product category.","enum":["APPLIANCES","APPS_AND_GAMES","ARTS_CRAFTS_AND_SEWING","AUTOMOTIVE","BABY","BEAUTY_AND_PERSONAL_CARE","BEVERAGES","BOOKS","CELL_PHONES_AND_ACCESSORIES","CLOTHING_SHOES_AND_JEWELRY","COMPUTERS_AND_ACCESSORIES","DIGITAL_MUSIC","EDUCATION","ELECTRONICS","FINANCIAL_AND_INSURANCE","FOOD","HEALTH_AND_HOUSEHOLD","HOME_AND_KITCHEN","HOSPITALITY","KITCHEN_AND_DINING","MOVIES_AND_TV","OFFICE_PRODUCTS","PATIO_LAWN_AND_GARDEN","PET_SUPPLIES","RESTAURANTS","SOFTWARE","SPORTS_AND_OUTDOORS","TELECOMMUNICATIONS_SERVICES","TOOLS_AND_HOME_IMPROVEMENT","TOYS_AND_GAMES","VIDEO_GAMES"],"type":"string"},"BrandLiftStudyResultV1":{"description":"The result of Brand Lift study.","properties":{"brandLiftSummary":{"description":"Summary of Brand Lift achieved for each objective.","items":{"$ref":"#/components/schemas/BrandLiftSummaryV1","properties":{}},"maxItems":50,"minItems":1,"type":"array"},"studyId":{"description":"The canonical Id of Study.","type":"string"},"surveyResponses":{"description":"Detailed response rate for each response in Survey question aggregated by different segments.","items":{"$ref":"#/components/schemas/SurveyResponseResultV1","properties":{}},"maxItems":2000,"minItems":1,"type":"array"},"totalResponses":{"description":"Total number of responses received in the Survey.","type":"number"}}},"BrandLiftStudyResultV1M1":{"description":"The result of Brand Lift study.","properties":{"brandLiftSummary":{"description":"Summary of Brand Lift achieved for each objective.","items":{"$ref":"#/components/schemas/BrandLiftSummaryV1M1","properties":{}},"maxItems":50,"minItems":1,"type":"array"},"studyId":{"description":"The canonical Id of Study.","type":"string"},"surveyResponses":{"description":"Detailed response rate for each response in Survey question aggregated by different segments.","items":{"$ref":"#/components/schemas/SurveyResponseResultV1M1","properties":{}},"maxItems":2000,"minItems":1,"type":"array"},"totalResponses":{"description":"Total number of responses received in the Survey.","type":"number"}}},"BrandLiftSummaryV1":{"description":"Summary of Brand Lift achieved for an objective.","properties":{"adExposedGroupRate":{"description":"Ad exposed group response rate.","format":"double","type":"number"},"benchmarkLiftRate":{"description":"The benchmark lift rate for the selected product category in the Survey.","format":"double","type":"number"},"controlGroupRate":{"description":"Control group response rate.","format":"double","type":"number"},"qualifyingResponses":{"description":"Qualifying responses aggregated to measure the Brand Lift.","items":{"properties":{},"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"questionObjective":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1"},"questionText":{"description":"Text of the Survey question.","type":"string"},"statisticalSignificance":{"description":"The significance percentage of achieved Brand Lift.","format":"double","type":"number"}}},"BrandLiftSummaryV1M1":{"description":"Summary of Brand Lift achieved for an objective.","properties":{"adExposedGroupRate":{"description":"Ad exposed group response rate.","type":"number"},"benchmarkLiftRate":{"description":"The benchmark lift rate for the selected product category in the Survey.","type":"number"},"controlGroupRate":{"description":"Control group response rate.","type":"number"},"qualifyingResponses":{"description":"Qualifying responses aggregated to measure the Brand Lift.","items":{"properties":{},"type":"string"},"maxItems":10,"minItems":0,"type":"array"},"questionObjective":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1M1"},"questionText":{"description":"Text of the Survey question.","type":"string"},"statisticalSignificance":{"description":"The significance percentage of achieved Brand Lift.","type":"number"}}},"CreateDSPAudienceResearchStudyV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1M2"},{"$ref":"#/components/schemas/DSPCampaignPlanningMetadataV1M2"},{"$ref":"#/components/schemas/DSPAudienceResearchMetadataV1M2"}],"description":"Create DSP AUDIENCE_RESEARCH study object.","type":"object"},"CreateDSPCreativeTestingStudyV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1M2"},{"$ref":"#/components/schemas/DSPCampaignPlanningMetadataV1M2"},{"$ref":"#/components/schemas/DSPCreativeTestingMetadataV1M2"}],"description":"Create DSP CREATIVE_TESTING study object.","type":"object"},"CreativeTestingStudyResultV1M2":{"description":"The result of Creative Testing study.","properties":{"studyId":{"description":"The canonical Id of Study.","type":"string"},"surveyResponses":{"description":"Detailed response rate for each response in Survey question aggregated by different segments.","items":{"$ref":"#/components/schemas/SurveyResponseResultV1M2","properties":{}},"maxItems":2000,"minItems":1,"type":"array"},"totalResponses":{"description":"Total number of responses received in the Survey.","type":"number"}}},"CustomSurveyQuestionV1":{"description":"The templated measurement survey question.","properties":{"questionText":{"description":"The survey question text.","type":"string"},"responses":{"items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"type":{"$ref":"#/components/schemas/SurveyQuestionTypeV1"}},"type":"object"},"DSPAudienceResearchEligibilityDataV1M2":{"description":"The audience research study eligibility data.","properties":{"audienceTargetingGroup":{"$ref":"#/components/schemas/AudienceTargetingGroupV1M2"}},"type":"object"},"DSPAudienceResearchEligibilityRequestV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1M2"},{"$ref":"#/components/schemas/DSPAudienceResearchEligibilityDataV1M2"}],"description":"The request object of DSP Audience Research study eligibility check."},"DSPAudienceResearchMetadataV1M2":{"description":"The basic model for all DSP AUDIENCE_RESEARCH objective studies.","properties":{"audienceTargetingGroup":{"$ref":"#/components/schemas/AudienceTargetingGroupV1M2"},"brandName":{"description":"The study brand name.","type":"string"},"peerNames":{"description":"A list of peer names for the study brand.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"productCategory":{"description":"The study product category.","type":"string"}},"type":"object"},"DSPAudienceResearchStudyV1M2":{"allOf":[{"properties":{"id":{"description":"The study canonical identifier. Immutable field.","properties":{},"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseStudyV1M2"},{"$ref":"#/components/schemas/DSPCampaignPlanningMetadataV1M2"},{"$ref":"#/components/schemas/DSPAudienceResearchMetadataV1M2"}],"description":"DSP AUDIENCE_RESEARCH study object.","type":"object"},"DSPBrandLiftEligibilityDataV1":{"description":"The campaign study eligibility data.","properties":{"currentStudyId":{"description":"Optional current study identifier, if provided orders are expected to be added into this study and the orders already associated with this study will be excluded from certain eligibility check.","type":"string"},"excludedLineItemIds":{"description":"A list of canonical lineItem identifiers that are excluded from the eligibility check.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"orderIds":{"description":"A list of canonical order identifiers. By default all lineItems in those orders will be included.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"DSPBrandLiftEligibilityRequestV1":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1"},{"$ref":"#/components/schemas/DSPBrandLiftEligibilityDataV1"}],"description":"The request object of DSP brand lift eligibility check.","type":"object"},"DSPBrandLiftEligibilityRequestV1M1":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1M1"},{"$ref":"#/components/schemas/DSPBrandLiftEligibilityDataV1"}],"description":"The request object of DSP brand lift eligibility check.","type":"object"},"DSPBrandLiftMetadataV1":{"description":"The basic model for all DSP BRAND_LIFT objective studies.","properties":{"benchmarkCategory":{"$ref":"#/components/schemas/BenchmarkCategoryV1"},"brandName":{"description":"The study brand name.","type":"string"},"peerNames":{"description":"A list of peer names for the study brand.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"productCategory":{"description":"The study product category.","type":"string"}},"type":"object"},"DSPBrandLiftMetadataV1M1":{"description":"The basic model for all DSP BRAND_LIFT objective studies.","properties":{"benchmarkCategory":{"$ref":"#/components/schemas/BenchmarkCategoryV1"},"brandName":{"description":"The study brand name.","type":"string"},"peerNames":{"description":"A list of peer names for the study brand.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"productCategory":{"description":"The study product category.","type":"string"},"verb":{"description":"The verb that will be used in the applicable survey questions to construct the question text.","type":"string"}},"type":"object"},"DSPBrandLiftStudyV1":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1"},{"$ref":"#/components/schemas/DSPCampaignMeasurementMetadataV1"},{"$ref":"#/components/schemas/DSPBrandLiftMetadataV1"}],"description":"DSP BRAND_LIFT study object.","type":"object"},"DSPBrandLiftStudyV1M1":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1M1"},{"$ref":"#/components/schemas/DSPCampaignMeasurementMetadataV1M1"},{"$ref":"#/components/schemas/DSPBrandLiftMetadataV1M1"}],"description":"DSP BRAND_LIFT study object.","type":"object"},"DSPCampaignMeasurementMetadataV1":{"description":"The basic model for all DSP CAMPAIGN_MEASUREMENT objective studies.","properties":{"advertiserId":{"description":"The associated advertiser identifier. Immutable field.","type":"string"},"excludedLineItemIds":{"description":"A list of canonical lineItem identifiers that are excluded from the study.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"orderIds":{"description":"A list of canonical order identifiers that are associated with the study. By default all lineItems in those orders will be included.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"DSPCampaignMeasurementMetadataV1M1":{"description":"The basic model for all DSP CAMPAIGN_MEASUREMENT objective studies.","properties":{"advertiserId":{"description":"The associated advertiser identifier. Immutable field.","type":"string"},"excludedLineItemIds":{"description":"A list of canonical lineItem identifiers that are excluded from the study.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"orderIds":{"description":"A list of canonical order identifiers that are associated with the study. By default all lineItems in those orders will be included.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"DSPCampaignPlanningMetadataV1M2":{"description":"The basic model for all DSP CAMPAIGN_PLANNING objective studies.","properties":{"advertiserId":{"description":"The associated advertiser identifier. Immutable field.","type":"string"}},"type":"object"},"DSPCreativeTestingEligibilityDataV1M2":{"description":"The creative testing study eligibility data.","properties":{"audienceTargetingGroup":{"$ref":"#/components/schemas/AudienceTargetingGroupV1M2"}},"type":"object"},"DSPCreativeTestingEligibilityRequestV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1M2"},{"$ref":"#/components/schemas/DSPCreativeTestingEligibilityDataV1M2"}],"description":"The request object of DSP Creative Testing study eligibility check."},"DSPCreativeTestingMetadataV1M2":{"description":"The basic model for all DSP CREATIVE_TESTING objective studies.","properties":{"assets":{"description":"A list of assets to be used for the creative testing study as part of either the survey question or the response. In case of API responses, number of assets returned would be limited to 10 even if a creative testing study has more than 10 assets associated with it.","items":{"$ref":"#/components/schemas/AssetV1M2"},"maxItems":10,"minItems":1,"type":"array"},"audienceTargetingGroup":{"$ref":"#/components/schemas/AudienceTargetingGroupV1M2"},"brandName":{"description":"The study brand name.","type":"string"},"productCategory":{"description":"Optional study product category.","type":"string"}},"type":"object"},"DSPCreativeTestingStudyV1M2":{"allOf":[{"properties":{"id":{"description":"The study canonical identifier. Immutable field.","properties":{},"type":"string"}},"type":"object"},{"$ref":"#/components/schemas/BaseStudyV1M2"},{"$ref":"#/components/schemas/DSPCampaignPlanningMetadataV1M2"},{"$ref":"#/components/schemas/DSPCreativeTestingMetadataV1M2"}],"description":"DSP CREATIVE_TESTING study object.","type":"object"},"DSPOmnichannelMetricsEligibilityDataV1M2":{"description":"The campaign study eligibility data.","properties":{"brandIds":{"description":"A list of canonical brand identifiers.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"currentStudyId":{"description":"Optional current study identifier. If provided orders are expected to be added into this study and the orders already associated with this study will be excluded from certain eligibility checks.","type":"string"},"excludedLineItemIds":{"description":"A list of canonical lineItem identifiers that are excluded from the eligibility check.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"orderIds":{"description":"A list of canonical order identifiers. By default all lineItems in those orders will be included.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DSPOmnichannelMetricsEligibilityRequestV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1M2"},{"$ref":"#/components/schemas/DSPOmnichannelMetricsEligibilityDataV1M2"}],"description":"The request object of DSP omnichannel metrics eligibility check."},"DSPOmnichannelMetricsEligibilityRequestV1M3":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1M3"},{"$ref":"#/components/schemas/DSPOmnichannelMetricsEligibilityDataV1M2"}],"description":"The request object of DSP omnichannel metrics eligibility check."},"DSPOmnichannelMetricsMetadataV1M2":{"description":"The basic model for all DSP OMNICHANNEL_METRICS objective studies.","properties":{"brandIds":{"description":"A list of canonical brand ids to be tracked for off-Amazon conversions.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"DSPOmnichannelMetricsStudyV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1"},{"$ref":"#/components/schemas/DSPCampaignMeasurementMetadataV1"},{"$ref":"#/components/schemas/DSPOmnichannelMetricsMetadataV1M2"}],"description":"DSP OMNICHANNEL_METRICS study object.","type":"object"},"DSPOmnichannelMetricsStudyV1M3":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1M1"},{"$ref":"#/components/schemas/DSPCampaignMeasurementMetadataV1M1"},{"$ref":"#/components/schemas/DSPOmnichannelMetricsMetadataV1M2"}],"description":"DSP OMNICHANNEL_METRICS study object.","type":"object"},"EligibilityFieldV1":{"description":"Fields that will be checked as part of eligibility API call.","enum":["BUDGET","END_TIME","FLIGHT_LENGTH","GOAL","IMPRESSIONS","LEAD_TIME","LOCALE","ORDER","START_TIME"],"type":"string"},"EligibilityFieldV1M2":{"description":"Fields that will be checked as part of eligibility API call.","enum":["BUDGET","BUYER_COUNT","END_TIME","FLIGHT_LENGTH","GOAL","IMPRESSIONS","INDUSTRY","LEAD_TIME","LOCALE","ORDER","START_TIME"],"type":"string"},"EligibilityIssueSeverityV1":{"description":"Supported values are WARNING, ERROR. ERROR severity issues need to be resolved while WARNING severity issues can be ignored.","enum":["ERROR","WARNING"],"type":"string"},"EligibilityIssueV1":{"description":"The list of eligibility issues.","properties":{"code":{"description":"An enumerated issue code for machine use.","type":"string"},"field":{"$ref":"#/components/schemas/EligibilityFieldV1"},"message":{"description":"A human-readable description of the issue with suggestions on how to resolve the issue.","type":"string"},"severity":{"$ref":"#/components/schemas/EligibilityIssueSeverityV1"}},"type":"object"},"EligibilityIssueV1M2":{"description":"The list of eligibility issues.","properties":{"code":{"description":"An enumerated issue code for machine use.","type":"string"},"field":{"$ref":"#/components/schemas/EligibilityFieldV1M2"},"message":{"description":"A human-readable description of the issue with suggestions on how to resolve the issue.","type":"string"},"severity":{"$ref":"#/components/schemas/EligibilityIssueSeverityV1"}}},"EligibilityMetadataV1":{"description":"The eligibility metadata.","properties":{"budget":{"description":"The total budget. Expressed in dollars.","format":"double","readOnly":true,"type":"number"},"endDate":{"description":"The latest end date of the associated orders in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"},"flightLength":{"description":"The flight length of the associated orders. Expressed in days.","readOnly":true,"type":"integer"},"impressions":{"description":"The total estimated impressions.","format":"int64","readOnly":true,"type":"integer"},"startDate":{"description":"The earliest start date of associated orders in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","readOnly":true,"type":"string"}}},"EligibilityResponseV1":{"description":"The eligibility check response object.","properties":{"metadata":{"$ref":"#/components/schemas/EligibilityMetadataV1"},"nextToken":{"type":"string"},"vendorProductEligibilities":{"items":{"$ref":"#/components/schemas/VendorProductEligibilityV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"EligibilityResponseV1M2":{"description":"The eligibility check response object.","properties":{"metadata":{"$ref":"#/components/schemas/EligibilityMetadataV1"},"nextToken":{"type":"string"},"vendorProductEligibilities":{"items":{"$ref":"#/components/schemas/VendorProductEligibilityV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"}}},"EligibilityStatusV1":{"description":"Supported values are ELIGIBLE, INELIGIBLE and ELIGIBLE_WITH_WARNING. INELIGIBLE status indicates the study can not be created.","enum":["ELIGIBLE","ELIGIBLE_WITH_WARNING","INELIGIBLE"],"type":"string"},"ErrorV1":{"description":"The error response object.","properties":{"errors":{"items":{"$ref":"#/components/schemas/SubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"message":{"description":"A human-readable description of the response.","type":"string"},"requestId":{"description":"Request Id that uniquely identifies your request.","type":"string"}},"type":"object"},"FundingTypeV1":{"description":"The measurement funding type. For COMPLIMENTARY studies the cost will be covered by Amazon.","enum":["COMPLIMENTARY"],"readOnly":true,"type":"string"},"FundingTypeV1M1":{"description":"The measurement funding type. For COMPLIMENTARY studies the cost will be covered by Amazon.","enum":["COMPLIMENTARY","THIRD_PARTY_PAYMENT"],"readOnly":true,"type":"string"},"FundingTypeV1M2":{"description":"The measurement funding type. For COMPLIMENTARY studies the cost will be covered by Amazon.","enum":["COMPLIMENTARY","CPM","FLAT_RATE"],"readOnly":true,"type":"string"},"FundingTypeV1M3":{"description":"The measurement funding type. For COMPLIMENTARY studies the cost will be covered by Amazon.","enum":["COMPLIMENTARY","CPM","THIRD_PARTY_PAYMENT"],"readOnly":true,"type":"string"},"GridQuestionResponsesV1M1":{"description":"The grid question response object. Only applicable for SINGLE_SELECT_GRID type question.","properties":{"columns":{"items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderFieldValueV1"},"maxItems":100,"minItems":0,"type":"array"},"rows":{"items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderFieldValueV1"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"MeasurementCountryV1":{"description":"The measurement country.","enum":["AE","AU","BR","CA","DE","ES","FR","IT","JP","MX","NL","UK","US"],"type":"string"},"MeasurementGoalV1":{"description":"The measurement budget optimization goal type goal.","enum":["AWARENESS","CONSIDERATIONS_ON_AMAZON","CONVERSIONS_OFF_AMAZON","ENGAGEMENT_WITH_MY_AD","MOBILE_APP_INSTALLS","PURCHASES_ON_AMAZON"],"type":"string"},"MeasurementLocaleV1":{"description":"The measurement locale.","enum":["DE_DE","EN_CA","EN_GB","EN_US","ES_ES","ES_MX","FR_FR","IT_IT","PT_BR"],"type":"string"},"MeasurementMarketplaceV1":{"description":"The marketplace with corresponding rules.","properties":{"country":{"$ref":"#/components/schemas/MeasurementCountryV1"},"minimumBudget":{"description":"The minimum budget. Expressed in dollars.","format":"double","type":"number"},"minimumImpressions":{"description":"The minimum impressions.","format":"int64","type":"integer"},"supportedLocales":{"items":{"$ref":"#/components/schemas/MeasurementLocaleV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"OmnichannelMetricsBrandSearchRequestV1M2":{"description":"The request object to fetch brands to be used in the OMNICHANNEL_METRICS vendor product.","properties":{"brandIdFilter":{"description":"List of brandIds in the omnichannel metrics brand catalog. Either one of brandIdFilter or brandNameSearch should be provided.","items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"brandNameSearch":{"description":"Text to search for eligible brands in the omnichannel metrics brand catalog. Either one of brandIdFilter or brandNameSearch should be provided.","type":"string"}},"type":"object"},"OmnichannelMetricsBrandV1M2":{"properties":{"brand":{"description":"The brand name.","type":"string"},"category":{"type":"string"},"company":{"type":"string"},"id":{"description":"The brand canonical Id","type":"string"},"majorBrand":{"type":"string"},"manufacturer":{"type":"string"},"subcategory":{"type":"string"}},"type":"object"},"PaginatedBaseStudiesV1":{"description":"A list of studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/BaseStudyV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedBaseStudiesV1M1":{"description":"A list of studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/BaseStudyV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedDSPAudienceResearchStudiesV1M2":{"description":"A list of audience research studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/DSPAudienceResearchStudyV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedDSPBrandLiftStudiesV1":{"description":"A list of studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedDSPBrandLiftStudiesV1M1":{"description":"A list of studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedDSPCreativeTestingStudiesV1M2":{"description":"A list of creative testing studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/DSPCreativeTestingStudyV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedDSPOmnichannelMetricsStudiesV1M2":{"description":"A list of studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/DSPOmnichannelMetricsStudyV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedDSPOmnichannelMetricsStudiesV1M3":{"description":"A list of studies.","properties":{"measurements":{"items":{"$ref":"#/components/schemas/DSPOmnichannelMetricsStudyV1M3","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"}},"type":"object"},"PaginatedOmnichannelMetricsBrandsV1M2":{"properties":{"brands":{"items":{"$ref":"#/components/schemas/OmnichannelMetricsBrandV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"},"totalResults":{"description":"The total number of matched brands.","format":"int32","type":"integer"}},"type":"object"},"PaginatedSurveyQuestionTemplatesV1":{"properties":{"nextToken":{"type":"string"},"surveyQuestionTemplates":{"items":{"$ref":"#/components/schemas/SurveyQuestionTemplateV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of templates.","format":"int32","type":"integer"}},"type":"object"},"PaginatedSurveyQuestionTemplatesV1M1":{"properties":{"nextToken":{"type":"string"},"surveyQuestionTemplates":{"items":{"$ref":"#/components/schemas/SurveyQuestionTemplateV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of templates.","format":"int32","type":"integer"}},"type":"object"},"PaginatedSurveysV1":{"description":"A list of study surveys.","properties":{"nextToken":{"type":"string"},"surveys":{"items":{"$ref":"#/components/schemas/SurveyV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"PaginatedSurveysV1M1":{"description":"A list of study surveys.","properties":{"nextToken":{"type":"string"},"surveys":{"items":{"$ref":"#/components/schemas/SurveyV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"PaginatedVendorProductPoliciesV1":{"description":"A list of measurement vendor products policies.","properties":{"nextToken":{"type":"string"},"policies":{"items":{"$ref":"#/components/schemas/VendorProductPolicyV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of vendor products.","format":"int32","type":"integer"}},"type":"object"},"PaginatedVendorProductPoliciesV1M1":{"description":"A list of measurement vendor products policies.","properties":{"nextToken":{"type":"string"},"policies":{"items":{"$ref":"#/components/schemas/VendorProductPolicyV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"totalResults":{"description":"The total number of vendor products.","format":"int32","type":"integer"}},"type":"object"},"PaginatedVendorProductsV1":{"description":"A list of measurement vendor products.","properties":{"nextToken":{"type":"string"},"totalResults":{"description":"The total number of vendor products.","format":"int32","type":"integer"},"vendorProducts":{"items":{"$ref":"#/components/schemas/VendorProductV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"PaginatedVendorProductsV1M1":{"description":"A list of measurement vendor products.","properties":{"nextToken":{"type":"string"},"totalResults":{"description":"The total number of vendor products.","format":"int32","type":"integer"},"vendorProducts":{"items":{"$ref":"#/components/schemas/VendorProductV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"PlaceholderValueTypeV1":{"description":"The placeholder value type.","enum":["INTEGER","STRING"],"type":"string"},"PlanningEligibilityDataV1M3":{"description":"The planning eligibility data.","properties":{"advertiserId":{"description":"The advertiserId.","type":"string"},"locale":{"$ref":"#/components/schemas/MeasurementLocaleV1"},"orderMetadata":{"items":{"$ref":"#/components/schemas/PlanningOrderMetadataV1M3"},"type":"array"},"studyTypeFilters":{"description":"StudyType identifier filters to be applied when checking eligibility status. If not supplied we will check against all available vendor products.","items":{"$ref":"#/components/schemas/StudyTypeV1M2"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"PlanningEligibilityRequestV1M3":{"allOf":[{"$ref":"#/components/schemas/BaseEligibilityRequestV1M2"},{"$ref":"#/components/schemas/PlanningEligibilityDataV1M3"}],"description":"The request object of planning eligibility check.","type":"object"},"PlanningEligibilityResponseV1M3":{"description":"The planning eligibility response object.","properties":{"metadata":{"$ref":"#/components/schemas/EligibilityMetadataV1"},"nextToken":{"type":"string"},"vendorProductEligibilities":{"items":{"$ref":"#/components/schemas/PlanningEligibilityV1M3","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"PlanningEligibilityV1M3":{"description":"The request object of measurement eligibility check.","properties":{"issues":{"description":"A list of issues will be provided if the status is INELIGIBLE or ELIGIBLE_WITH_WARNING.","items":{"$ref":"#/components/schemas/EligibilityIssueV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"rank":{"description":"The lower the number, the more recommended the vendor product is.","type":"number"},"status":{"$ref":"#/components/schemas/EligibilityStatusV1"},"vendorProductId":{"description":"Vendor product canonical identifier.","type":"string"}},"type":"object"},"PlanningOrderMetadataV1M3":{"description":"Metadata around a hypothetical order.","properties":{"budget":{"description":"The total estimated budget of the order.","format":"double","type":"number"},"endDate":{"description":"The estimated end date of the order in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","type":"string"},"goal":{"$ref":"#/components/schemas/MeasurementGoalV1"},"impressions":{"description":"The total estimated impressions of the order.","format":"int64","type":"integer"},"startDate":{"description":"The estimated start date of the order in ISO format (YYYY-MM-DDThh:mm:ssTZD). Timezone is UTC.","format":"date-time","type":"string"}},"type":"object"},"ResourceLinkV1M1":{"description":"The link that can be used to access corresponding resources in advertising portal.","properties":{"name":{"description":"The resource name.","type":"string"},"url":{"description":"The resource url.","type":"string"}},"type":"object"},"StudyObjectiveV1":{"description":"Measurement category based on the purpose of the measurement.","enum":["CAMPAIGN_MEASUREMENT","CAMPAIGN_PLANNING"],"type":"string"},"StudyResponseV1":{"description":"Study response.","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"errors":{"items":{"$ref":"#/components/schemas/SubErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message of the code.","type":"string"},"studyId":{"description":"The study canonical identifier.","type":"string"}},"type":"object"},"StudyResponsesV1":{"description":"Studies response.","properties":{"requestId":{"description":"Request Id that uniquely identifies your request.","type":"string"},"responses":{"items":{"$ref":"#/components/schemas/StudyResponseV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"StudyStatusV1":{"description":"The study status. Only required if study is in DRAFT as part of study creation/update.","enum":["APPROVED","CANCELLED","DRAFT","ENDED","INFEASIBLE","PENDING","REJECTED","RUNNING"],"type":"string"},"StudySubmissionTypeV1":{"description":"The submission type for the creation and updating of studies. Currently, this submission type is supported for brand lift studies only.","enum":["DRAFT","SUBMISSION"],"type":"string","writeOnly":true},"StudyTypeV1":{"description":"The study type.","enum":["BRAND_LIFT"],"readOnly":true,"type":"string"},"StudyTypeV1M2":{"description":"The study type.","enum":["AUDIENCE_RESEARCH","BRAND_LIFT","CREATIVE_TESTING","OMNICHANNEL_METRICS"],"readOnly":true,"type":"string"},"SubErrorV1":{"description":"The sub error object.","properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"},"SurveyErrorV1":{"description":"The survey error object.","properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"},"questionTemplateId":{"type":"string"}},"required":["errorType","message"],"type":"object"},"SurveyQuestionCategoryRequirementV1M1":{"description":"The requirement for specific survey question category.","properties":{"category":{"$ref":"#/components/schemas/SurveyQuestionCategoryV1M1"},"maximumQuestions":{"description":"The maximum number of questions required for the question category.","type":"integer"},"minimumQuestions":{"description":"The minimum number of questions required for the question category.","type":"integer"}},"type":"object"},"SurveyQuestionCategoryV1M1":{"description":"The survey question category.","enum":["BRAND_KPI","CUSTOM","WEIGHTING"],"readOnly":true,"type":"string"},"SurveyQuestionGridQuestionResponseV1M1":{"description":"The grid question response object. Only applicable for SINGLE_SELECT_GRID type question.","properties":{"columns":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderCandidateV1"},"rows":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderCandidateV1"}},"type":"object"},"SurveyQuestionObjectiveTypeV1":{"description":"The survey objective.","enum":["AD_RECALL","ASSOCIATION","ATTITUDES","AWARENESS","BEHAVIORS","FAMILIARITY","FAVORABILITY","INTENT","PREFERENCE"],"readOnly":true,"type":"string"},"SurveyQuestionObjectiveTypeV1M1":{"description":"The survey objective.","enum":["AD_RECALL","AGE","AMAZON_SERVICE_USAGE","ATTITUDES","AWARENESS","BEHAVIORS","CHILDREN_IN_HOUSEHOLD","CONSIDERATION","EDUCATION","ETHNICITY","FAMILIARITY","FAVORABILITY","GENDER","HOUSEHOLD_INCOME","HOUSEHOLD_SIZE","INTENT","IN_MARKET_STATUS","PREFERENCE","PURCHASE_FREQUENCY","PURCHASE_HISTORY","PURCHASE_LOCATION","TIME_ONLINE","TV_MEDIA_CONSUMPTION","UNAIDED_AWARENESS"],"readOnly":true,"type":"string"},"SurveyQuestionPlaceholderAllowedRangeV1":{"description":"Allowed value range for placeholder.","properties":{"maximumValue":{"description":"The maximum allowed value.","format":"int32","type":"integer"},"minimumValue":{"description":"The minimum allowed value.","format":"int32","type":"integer"},"parentField":{"description":"The field name that this range depends on. Will be empty if this range is the default range.","type":"string"},"parentValue":{"description":"The field value that this range depends on. Will be empty if this range is the default range.","type":"string"}},"type":"object"},"SurveyQuestionPlaceholderAllowedValueV1":{"description":"Allowed values for placeholder.","properties":{"parentField":{"description":"The field name that this value list depends on. Will be empty if this is the default list.","type":"string"},"parentValue":{"description":"The field value that this value list depend on. Will be empty if this is the default list.","type":"string"},"values":{"description":"Allowed values for placeholder.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SurveyQuestionPlaceholderCandidateV1":{"description":"The placeholder candidate in Survey question.","properties":{"allowCustomValue":{"description":"Whether custom value is allowed for the placeholder.","type":"boolean"},"allowedValueRanges":{"description":"Allowed value ranges for placeholder. Only applicable if the valueType is INTEGER.","items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderAllowedRangeV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"allowedValues":{"description":"Allowed values for placeholder. Will be empty if placeholder is free text field.","items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderAllowedValueV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"defaultValues":{"description":"Default values that will be appended to the values list regardless.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"fieldName":{"description":"The survey question placeholder field name.","type":"string"},"inferredFields":{"description":"Where the placeholder values will be inferred from.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"maximumValueLength":{"description":"The maximum allowed character length for each individual placeholder value.","type":"integer"},"minimumValueLength":{"description":"The minimum allowed character length for each individual placeholder value.","type":"integer"},"valueType":{"$ref":"#/components/schemas/PlaceholderValueTypeV1"}},"type":"object"},"SurveyQuestionPlaceholderFieldValueV1":{"properties":{"isQualifying":{"description":"This is only required if the corresponding field is 'response', this will help to define if the response value will be counted as a positive one in the study report.","type":"boolean"},"value":{"description":"The survey question placeholder field value.","type":"string"}},"type":"object"},"SurveyQuestionPlaceholderV1":{"description":"The object specifying a placeholder in Survey question.","properties":{"fieldName":{"description":"The survey question placeholder field name.","type":"string"},"fieldValues":{"description":"The survey question placeholder field values.","items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderFieldValueV1"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SurveyQuestionResponseV1M2":{"description":"The survey question response chosen by Survey audience.","properties":{"asset":{"$ref":"#/components/schemas/AssetV1M2"},"responseType":{"description":"The type of response.","enum":["ASSET","TEXT"],"type":"string"},"responseValue":{"description":"The response text if the question response type is TEXT.","type":"string"}}},"SurveyQuestionSubCategoryV1M1":{"description":"The survey question sub-category. Only applicable to certain categories","enum":["BEHAVIOR","DEMOGRAPHIC","PURCHASE_HISTORY"],"readOnly":true,"type":"string"},"SurveyQuestionTemplateV1":{"description":"Survey question template for vendor product.","properties":{"id":{"description":"The survey question template canonical Id.","type":"string"},"locale":{"$ref":"#/components/schemas/MeasurementLocaleV1"},"maximumQualifyingResponses":{"description":"The maximum number of qualifying responses allowed for the question. This will be available if the qualifying responses are not pre-defined/inferred.","type":"integer"},"maximumQuestionResponses":{"description":"The maximum number of responses allowed for the question. This will be available if the question responses are not pre-defined/inferred.","type":"integer"},"minimumQualifyingResponses":{"description":"The minimum number of qualifying responses required for the question. This will be available if the qualifying responses are not pre-defined/inferred.","type":"integer"},"minimumQuestionResponses":{"description":"The minimum number of responses required for the question. This will be available if the question responses are not pre-defined/inferred.","type":"integer"},"objectiveType":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1"},"placeholderCandidates":{"items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderCandidateV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"qualifyingResponses":{"description":"The pre-defined qualifying survey question responses with placeholders, this will help to define which responses will be counted as positive ones in the study report.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"questionResponses":{"description":"The pre-defined survey question responses with placeholders.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"questionText":{"description":"The survey question text with placeholders.","type":"string"},"type":{"$ref":"#/components/schemas/SurveyQuestionTypeV1"},"vendorProductId":{"description":"The associated vendor product id.","type":"string"}},"type":"object"},"SurveyQuestionTemplateV1M1":{"description":"Survey question template for vendor product.","properties":{"category":{"$ref":"#/components/schemas/SurveyQuestionCategoryV1M1"},"gridQuestionResponse":{"$ref":"#/components/schemas/SurveyQuestionGridQuestionResponseV1M1"},"id":{"description":"The survey question template canonical Id.","type":"string"},"locale":{"$ref":"#/components/schemas/MeasurementLocaleV1"},"maximumQualifyingResponses":{"description":"The maximum number of qualifying responses allowed for the question. This will be available if the qualifying responses are not pre-defined/inferred.","type":"integer"},"maximumQuestionResponses":{"description":"The maximum number of responses allowed for the question. This will be available if the question responses are not pre-defined/inferred.","type":"integer"},"minimumQualifyingResponses":{"description":"The minimum number of qualifying responses required for the question. This will be available if the qualifying responses are not pre-defined/inferred.","type":"integer"},"minimumQuestionResponses":{"description":"The minimum number of responses required for the question. This will be available if the question responses are not pre-defined/inferred.","type":"integer"},"objectiveType":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1M1"},"placeholderCandidates":{"items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderCandidateV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"priority":{"description":"The priority of the question. If present this will determine the ordering of questions in a survey. The check will be enforced when a survey is created/updated. Lower number indicates higher priority.","type":"integer"},"qualifyingResponses":{"description":"The pre-defined qualifying survey question responses with placeholders, this will help to define which responses will be counted as positive ones in the study report.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"questionResponses":{"description":"The pre-defined survey question responses with placeholders.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"questionText":{"description":"The survey question text with placeholders.","type":"string"},"subCategory":{"$ref":"#/components/schemas/SurveyQuestionSubCategoryV1M1"},"type":{"$ref":"#/components/schemas/SurveyQuestionTypeV1M1"},"vendorProductId":{"description":"The associated vendor product id.","type":"string"}},"type":"object"},"SurveyQuestionTypeV1":{"description":"The survey question type. SINGLE_SELECT question will allow customers to choose only one response, MULTI_SELECT question will allow customers to choose multiple responses, RATING will allow customers...","enum":["FREE_TEXT","MULTI_SELECT","RATING","SINGLE_ASSET_SELECT","SINGLE_SELECT"],"readOnly":true,"type":"string"},"SurveyQuestionTypeV1M1":{"description":"The survey question type. SINGLE_SELECT question will allow customers to choose only one response, MULTI_SELECT question will allow customers to choose multiple responses, RATING will allow customers...","enum":["FREE_TEXT","MULTI_SELECT","RATING","SINGLE_SELECT","SINGLE_SELECT_GRID"],"readOnly":true,"type":"string"},"SurveyResponseResultV1":{"description":"The rate of response for each response in Survey question.","properties":{"adExposedGroupResponseRate":{"description":"The percent of people in ad exposed group choosing this response.","format":"double","type":"number"},"controlGroupResponseRate":{"description":"The percent of people in control group choosing this response.","format":"double","type":"number"},"isQualifyingResponse":{"description":"Is the response a qualifying response. Used in calculating Brand Lift.","type":"boolean"},"marginOfError":{"description":"The percentage of margin of error for this response.","type":"number"},"questionObjective":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1"},"questionResponse":{"description":"The response choosen by Survey audience.","type":"string"},"questionSequence":{"description":"Sequence number of the question in the Survey.","type":"number"},"questionText":{"description":"Text of the Survey question.","type":"string"},"responseRate":{"description":"The percentage of people choosing this response.","format":"double","type":"number"},"segmentType":{"description":"The segment type to which this response data belongs to.","enum":["AGE","AUDIENCES","CHANNEL","FREQUENCY","GENDER","HOUSEHOLD_INCOME","OVERALL"],"type":"string"},"segmentValue":{"description":"The segment value to which this response data belongs to. Would be corresponding to the above segmentType field.","type":"string"},"statisticalSignificance":{"description":"The significance percentage for the response data in this segment.","format":"double","type":"number"}}},"SurveyResponseResultV1M1":{"description":"The rate of response for each response in Survey question.","properties":{"adExposedGroupResponseRate":{"description":"The percent of people in ad exposed group choosing this response.","type":"number"},"controlGroupResponseRate":{"description":"The percent of people in control group choosing this response.","type":"number"},"isQualifyingResponse":{"description":"Is the response a qualifying response. Used in calculating Brand Lift.","type":"boolean"},"questionObjective":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1M1"},"questionResponse":{"description":"The response choosen by Survey audience.","type":"string"},"questionSequence":{"description":"Sequence number of the question in the Survey.","type":"number"},"questionText":{"description":"Text of the Survey question.","type":"string"},"responseRate":{"description":"The percentage of people choosing this response.","type":"number"},"segmentType":{"description":"The segment type to which this response data belongs to.","enum":["AGE","AUDIENCES","CHANNEL","FREQUENCY","GENDER","HOUSEHOLD_INCOME","OVERALL"],"type":"string"},"segmentValue":{"description":"The segment value to which this response data belongs to. Would be corresponding to the above segmentType field.","type":"string"},"statisticalSignificance":{"description":"The significance percentage for the response data in this segment.","type":"number"}}},"SurveyResponseResultV1M2":{"description":"The rate of response for each response in Survey question.","properties":{"adExposedGroupResponseRate":{"description":"The percent of people in ad exposed group choosing this response.","format":"double","type":"number"},"controlGroupResponseRate":{"description":"The percent of people in control group choosing this response.","format":"double","type":"number"},"isQualifyingResponse":{"description":"Is the response a qualifying response. Used in calculating Brand Lift.","type":"boolean"},"marginOfError":{"description":"The percentage of margin of error for this response.","type":"number"},"questionAsset":{"$ref":"#/components/schemas/AssetV1M2"},"questionObjective":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1"},"questionResponse":{"$ref":"#/components/schemas/SurveyQuestionResponseV1M2"},"questionSequence":{"description":"Sequence number of the question in the Survey.","type":"number"},"questionText":{"description":"Text of the Survey question.","type":"string"},"responseRate":{"description":"The percentage of people choosing this response.","format":"double","type":"number"},"segmentType":{"description":"The segment type to which this response data belongs to.","enum":["AGE","AUDIENCES","CHANNEL","FREQUENCY","GENDER","HOUSEHOLD_INCOME","OVERALL"],"type":"string"},"segmentValue":{"description":"The segment value to which this response data belongs to. Would be corresponding to the above segmentType field.","type":"string"},"statisticalSignificance":{"description":"The significance percentage for the response data in this segment.","format":"double","type":"number"}}},"SurveyResponseV1":{"description":"Survey response.","properties":{"code":{"description":"An enumerated success or error code for machine use.","type":"string"},"errors":{"items":{"$ref":"#/components/schemas/SurveyErrorV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"index":{"description":"The index of the object in the request, starting from 1.","format":"int32","type":"integer"},"message":{"description":"A human-readable message of the code.","type":"string"},"surveyId":{"description":"The survey canonical identifier.","type":"string"}},"type":"object"},"SurveyResponsesV1":{"description":"Surveys response.","properties":{"requestId":{"description":"Request Id that uniquely identifies your request.","type":"string"},"responses":{"items":{"$ref":"#/components/schemas/SurveyResponseV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"SurveyStatusV1":{"description":"The survey status. Only required if the survey is in DRAFT. Created survey will be in AVAILABLE status by default and will only be in IN_USE status if it's associated with a study.","enum":["AVAILABLE","DRAFT","IN_USE"],"type":"string"},"SurveyV1":{"description":"The measurement survey.","properties":{"customQuestions":{"description":"A list of custom survey questions.","items":{"$ref":"#/components/schemas/CustomSurveyQuestionV1"},"maxItems":100,"minItems":1,"type":"array"},"id":{"description":"The survey canonical identifier. Immutable field. This is required for update.","type":"string"},"status":{"$ref":"#/components/schemas/SurveyStatusV1"},"studyId":{"description":"The associated study identifier. Survey needs to be created prior to the study creation.","readOnly":true,"type":"string"},"templatedQuestions":{"description":"A list of templated survey questions.","items":{"$ref":"#/components/schemas/TemplatedSurveyQuestionV1"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductId":{"description":"The vendor product canonical identifier.","type":"string"}},"type":"object"},"SurveyV1M1":{"description":"The measurement survey.","properties":{"customQuestions":{"description":"A list of custom survey questions.","items":{"$ref":"#/components/schemas/CustomSurveyQuestionV1"},"maxItems":100,"minItems":1,"type":"array"},"id":{"description":"The survey canonical identifier. Immutable field. This is required for update.","type":"string"},"status":{"$ref":"#/components/schemas/SurveyStatusV1"},"studyId":{"description":"The associated study identifier. Survey needs to be created prior to the study creation.","readOnly":true,"type":"string"},"templatedQuestions":{"description":"A list of templated survey questions.","items":{"$ref":"#/components/schemas/TemplatedSurveyQuestionV1M1"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductId":{"description":"The vendor product canonical identifier.","type":"string"}},"type":"object"},"TemplatedSurveyQuestionV1":{"description":"The templated measurement survey question.","properties":{"id":{"description":"The survey question template canonical identifier.","type":"string"},"placeholders":{"description":"List of question placeholders","items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderV1"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"TemplatedSurveyQuestionV1M1":{"description":"The templated measurement survey question.","properties":{"gridQuestionResponse":{"$ref":"#/components/schemas/GridQuestionResponsesV1M1"},"id":{"description":"The survey question template canonical identifier.","type":"string"},"placeholders":{"description":"List of question placeholders","items":{"$ref":"#/components/schemas/SurveyQuestionPlaceholderV1"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"UpdateDSPAudienceResearchStudyV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1M2"},{"$ref":"#/components/schemas/DSPCampaignPlanningMetadataV1M2"},{"$ref":"#/components/schemas/DSPAudienceResearchMetadataV1M2"}],"description":"Update DSP AUDIENCE_RESEARCH study object.","type":"object"},"UpdateDSPCreativeTestingStudyV1M2":{"allOf":[{"$ref":"#/components/schemas/BaseStudyV1M2"},{"$ref":"#/components/schemas/DSPCampaignPlanningMetadataV1M2"},{"$ref":"#/components/schemas/DSPCreativeTestingMetadataV1M2"}],"description":"Update DSP CREATIVE_TESTING study object.","type":"object"},"VendorProductEligibilityV1":{"description":"The measurement eligibility details for a certain vendor product.","properties":{"issues":{"description":"A list of issues will be provided if the status is INELIGIBLE or ELIGIBLE_WITH_WARNING.","items":{"$ref":"#/components/schemas/EligibilityIssueV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/EligibilityStatusV1"},"vendorProductId":{"description":"vendor product canonical identifier.","type":"string"}},"type":"object"},"VendorProductEligibilityV1M2":{"description":"The measurement eligibility details for a certain vendor product.","properties":{"issues":{"description":"A list of issues will be provided if the status is INELIGIBLE or ELIGIBLE_WITH_WARNING.","items":{"$ref":"#/components/schemas/EligibilityIssueV1M2","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"status":{"$ref":"#/components/schemas/EligibilityStatusV1"},"vendorProductId":{"description":"vendor product canonical identifier.","type":"string"}},"type":"object"},"VendorProductPolicyV1":{"description":"The policy rules will be enforced at vendor product level.","properties":{"benchMarkCategoryRequired":{"description":"Whether or not the benchMark category is required for measurement setup.","type":"boolean"},"customQuestionAllowed":{"description":"Whether custom survey questions are allowed.","type":"boolean"},"externalReferenceIdRequired":{"description":"Whether or not the vendor assigned external reference identifier is required for measurement setup.","type":"boolean"},"leadTime":{"description":"Days required for measurement configuration. It is recommended that the startDate of the campaign has sufficient padding to accommodate this lead time, but measurement can begin after the campaign start date in some cases.","type":"integer"},"maximumOrders":{"description":"The maximum number of order allowed for the product.","type":"integer"},"maximumPeerNames":{"description":"The maximum number of peer names required for the product.","type":"integer"},"maximumStudyLength":{"description":"The maximum required length/duration of the study in days.","type":"integer"},"maximumSurveyQuestions":{"description":"The maximum number of survey questions required for the product.","type":"integer"},"minimumOrders":{"description":"The maximum number of orders required for the product.","type":"integer"},"minimumPeerNames":{"description":"The minimum number of peer names required for the product.","type":"integer"},"minimumStudyLength":{"description":"The minimum required length/duration of the study in days.","type":"integer"},"minimumSurveyQuestions":{"description":"The minimum number of survey questions required for the product.","type":"integer"},"requiredQuestionObjectives":{"description":"The required question objectives that need to be included as part of the survey.","items":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"supportedGoals":{"items":{"$ref":"#/components/schemas/MeasurementGoalV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"supportedMarketplaces":{"items":{"$ref":"#/components/schemas/MeasurementMarketplaceV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"vendorApprovalRequired":{"description":"Whether or not the vendor requires an additional sign off process to fully qualify for study.","type":"boolean"},"vendorProductId":{"description":"vendor product canonical identifier.","type":"string"}},"type":"object"},"VendorProductPolicyV1M1":{"description":"The policy rules will be enforced at vendor product level.","properties":{"benchMarkCategoryRequired":{"description":"Whether or not the benchMark category is required for measurement setup.","type":"boolean"},"customQuestionAllowed":{"description":"Whether custom survey questions are allowed.","type":"boolean"},"externalReferenceIdRequired":{"description":"Whether or not the vendor assigned external reference identifier is required for measurement setup.","type":"boolean"},"leadTime":{"description":"Days required for measurement configuration. It is recommended that the startDate of the campaign has sufficient padding to accommodate this lead time, but measurement can begin after the campaign start date in some cases.","type":"integer"},"maximumOrders":{"description":"The maximum number of order allowed for the product.","type":"integer"},"maximumPeerNames":{"description":"The maximum number of peer names required for the product.","type":"integer"},"maximumStudyLength":{"description":"The maximum required length/duration of the study in days.","type":"integer"},"maximumSurveyQuestions":{"description":"The maximum number of survey questions required for the product.","type":"integer"},"minimumOrders":{"description":"The maximum number of orders required for the product.","type":"integer"},"minimumPeerNames":{"description":"The minimum number of peer names required for the product.","type":"integer"},"minimumStudyLength":{"description":"The minimum required length/duration of the study in days.","type":"integer"},"minimumSurveyQuestions":{"description":"The minimum number of survey questions required for the product.","type":"integer"},"requiredQuestionCategories":{"description":"The requirements for survey question categories.","items":{"$ref":"#/components/schemas/SurveyQuestionCategoryRequirementV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"requiredQuestionObjectives":{"description":"The required question objectives that need to be included as part of the survey.","items":{"$ref":"#/components/schemas/SurveyQuestionObjectiveTypeV1M1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"supportedGoals":{"items":{"$ref":"#/components/schemas/MeasurementGoalV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"supportedMarketplaces":{"items":{"$ref":"#/components/schemas/MeasurementMarketplaceV1","properties":{}},"maxItems":100,"minItems":0,"type":"array"},"supportedVerbs":{"description":"List of supported verbs that can be used in survey questions.","items":{"properties":{},"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"vendorApprovalRequired":{"description":"Whether or not the vendor requires an additional sign off process to fully qualify for study.","type":"boolean"},"vendorProductId":{"description":"vendor product canonical identifier.","type":"string"},"verbRequired":{"description":"Whether or not a verb is required for measurement setup. It will be used in applicable survey questions to construct the question text.","type":"boolean"}},"type":"object"},"VendorProductRequestV1":{"description":"The request object to fetch measurement vendor products.","properties":{"adTypeFilters":{"description":"AdType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/AdTypeV1"},"maxItems":100,"minItems":1,"type":"array"},"fundingTypeFilters":{"description":"FundingType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/FundingTypeV1"},"maxItems":100,"minItems":1,"type":"array"},"objectiveTypeFilters":{"description":"StudyObjective filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/StudyObjectiveV1"},"maxItems":100,"minItems":1,"type":"array"},"studyTypeFilters":{"description":"StudyType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/StudyTypeV1"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductIdFilters":{"description":"VendorProduct identifier filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"vendorTypeFilters":{"description":"VendorType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/VendorTypeV1"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"VendorProductRequestV1M1":{"description":"The request object to fetch measurement vendor products.","properties":{"adTypeFilters":{"description":"AdType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/AdTypeV1"},"maxItems":100,"minItems":1,"type":"array"},"fundingTypeFilters":{"description":"FundingType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/FundingTypeV1M1"},"maxItems":100,"minItems":1,"type":"array"},"objectiveTypeFilters":{"description":"StudyObjective filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/StudyObjectiveV1"},"maxItems":100,"minItems":1,"type":"array"},"studyTypeFilters":{"description":"StudyType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/StudyTypeV1"},"maxItems":100,"minItems":1,"type":"array"},"vendorProductIdFilters":{"description":"VendorProduct identifier filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"vendorTypeFilters":{"description":"VendorType filters to be applied when fetching measurement vendor products. If not supplied we will include all available vendor products.","items":{"$ref":"#/components/schemas/VendorTypeV1M1"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"VendorProductTypeV1":{"description":"The measurement vendor product type.","enum":["SHOPPER_PANEL"],"readOnly":true,"type":"string"},"VendorProductTypeV1M1":{"description":"The measurement vendor product type.","enum":["BRAND_LIFT_INSIGHTS","DASH","DIGITAL_BRAND_EFFECT","DYNATA","EXPANDED_VIEW_LITE","LUCID","MACROMILL","SHOPPER_PANEL","UPWAVE"],"readOnly":true,"type":"string"},"VendorProductV1":{"description":"The measurement vendor product.","properties":{"adType":{"$ref":"#/components/schemas/AdTypeV1"},"fundingType":{"$ref":"#/components/schemas/FundingTypeV1"},"id":{"description":"The vendor product identifier.","readOnly":true,"type":"string"},"objective":{"$ref":"#/components/schemas/StudyObjectiveV1"},"studyType":{"$ref":"#/components/schemas/StudyTypeV1"},"vendorProductType":{"$ref":"#/components/schemas/VendorProductTypeV1"},"vendorType":{"$ref":"#/components/schemas/VendorTypeV1"}},"type":"object"},"VendorProductV1M1":{"description":"The measurement vendor product.","properties":{"adType":{"$ref":"#/components/schemas/AdTypeV1"},"displayName":{"description":"The vendor product display name.","readOnly":true,"type":"string"},"fundingType":{"$ref":"#/components/schemas/FundingTypeV1M1"},"id":{"description":"The vendor product identifier.","readOnly":true,"type":"string"},"objective":{"$ref":"#/components/schemas/StudyObjectiveV1"},"studyType":{"$ref":"#/components/schemas/StudyTypeV1"},"vendorProductType":{"$ref":"#/components/schemas/VendorProductTypeV1M1"},"vendorType":{"$ref":"#/components/schemas/VendorTypeV1M1"}},"type":"object"},"VendorTypeV1":{"description":"The measurement vendor type, each study type will have different supported vendors.","enum":["AMAZON"],"readOnly":true,"type":"string"},"VendorTypeV1M1":{"description":"The measurement vendor type, each study type will have different supported vendors.","enum":["AMAZON","DYNATA","KANTAR","LUCID","MACROMILL","NIELSEN","UPWAVE"],"readOnly":true,"type":"string"},"VendorTypeV1M2":{"description":"The measurement vendor type, each study type will have different supported vendors.","enum":["AMAZON","OMNICHANNEL_METRICS"],"readOnly":true,"type":"string"},"VendorTypeV1M3":{"description":"The measurement vendor type, each study type will have different supported vendors.","enum":["AMAZON","DYNATA","KANTAR","LUCID","MACROMILL","NIELSEN","OMNICHANNEL_METRICS","UPWAVE"],"readOnly":true,"type":"string"}},"securitySchemes":{}},"info":{"title":"Measurement","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/measurement/eligibility/audienceResearch":{"post":{"description":"Checks the DSP AUDIENCE_RESEARCH study type eligibility status against vendor products.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CheckDSPAudienceResearchEligibility","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPAudienceResearchEligibilityRequestV1M2"}}},"description":"The DSP audience research study eligibility request object."},"responses":{"200":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/EligibilityResponseV1M2"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Checks the DSP AUDIENCE_RESEARCH study type eligibility against vendor products.","tags":["Measurement"]}},"/dsp/measurement/eligibility/brandLift":{"post":{"description":"Checks the DSP BRAND_LIFT study type eligibility status against vendor products.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CheckDSPBrandLiftEligibility","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/DSPBrandLiftEligibilityRequestV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/DSPBrandLiftEligibilityRequestV1M1"}}},"description":"The DSP brand lift eligibility request object."},"responses":{"200":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/EligibilityResponseV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/EligibilityResponseV1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementeligibility.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Checks the DSP BRAND_LIFT study type eligibility against vendor products.","tags":["Measurement"]}},"/dsp/measurement/eligibility/creativeTesting":{"post":{"description":"Checks the DSP CREATIVE_TESTING study type eligibility status against vendor products.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CheckDSPCreativeTestingEligibility","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPCreativeTestingEligibilityRequestV1M2"}}},"description":"The DSP creative testing study eligibility request object."},"responses":{"200":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/EligibilityResponseV1M2"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Checks the DSP CREATIVE_TESTING study type eligibility against vendor products.","tags":["Measurement"]}},"/dsp/measurement/eligibility/omnichannelMetrics":{"post":{"description":"Checks the DSP OMNICHANNEL_METRICS study type eligibility status against vendor products.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CheckDSPOmnichannelMetricsEligibility","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPOmnichannelMetricsEligibilityRequestV1M2"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/DSPOmnichannelMetricsEligibilityRequestV1M3"}}},"description":"The DSP omnichannel metrics eligibility request object."},"responses":{"200":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/EligibilityResponseV1M2"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/EligibilityResponseV1M2"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementeligibility.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Checks the DSP OMNICHANNEL_METRICS study type eligibility against vendor products.","tags":["Measurement"]}},"/dsp/measurement/studies/audienceResearch":{"get":{"description":"Gets one or more DSP AUDIENCE_RESEARCH studies with requested study identifiers or an advertiser identifier.","operationId":"GetDSPAudienceResearchStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Study canonical identifier to filter with. Either one of studyIds or advertiserId should be provided.","explode":false,"in":"query","name":"studyIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"The advertiser canonical identifier. Either one of studyIds or advertiserId should be provided.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPAudienceResearchStudiesV1M2"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets one or more DSP AUDIENCE_RESEARCH studies with requested study identifiers or an advertiser identifier.","tags":["Measurement"]},"post":{"description":"Create new DSP AUDIENCE_RESEARCH study.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CreateDSPAudienceResearchStudy","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/CreateDSPAudienceResearchStudyV1M2"}}},"description":"Create object for DSP AUDIENCE_RESEARCH study."},"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPAudienceResearchStudyV1M2"}}},"description":"Success."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad request."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."}},"summary":"Create new DSP AUDIENCE_RESEARCH study.","tags":["Measurement"]}},"/dsp/measurement/studies/audienceResearch/{studyId}":{"put":{"description":"Update DSP AUDIENCE_RESEARCH study. This will be a full update.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"UpdateDSPAudienceResearchStudy","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"The canonical identifier that represents a unique study.","in":"path","name":"studyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/UpdateDSPAudienceResearchStudyV1M2"}}},"description":"Update object for DSP AUDIENCE_RESEARCH study."},"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPAudienceResearchStudyV1M2"}}},"description":"Success."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad request."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."}},"summary":"Update DSP AUDIENCE_RESEARCH study. This will be a full update.","tags":["Measurement"]}},"/dsp/measurement/studies/audienceResearch/{studyId}/result":{"get":{"description":"Get result of a DSP AUDIENCE_RESEARCH study. Returns 200 successful response if json resource is requested in Accept header.","operationId":"GetDSPAudienceResearchStudyResult","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"The version(s) of the requested resource. Available version(s) - `application/vnd.measurementresult.v1.2+json`, `text/vnd.measurementresult.v1.2+csv`.","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The canonical identifier that represents a unique study.","in":"path","name":"studyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/AudienceResearchStudyResultV1M2"}}},"description":"Successful operation."},"307":{"description":"Successful operation for downloading result file."},"400":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Get result of a DSP AUDIENCE_RESEARCH study.","tags":["Measurement"]}},"/dsp/measurement/studies/brandLift":{"get":{"description":"Gets one or more DSP BRAND_LIFT studies with requested study identifiers or an advertiser identifier.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:...","operationId":"GetDSPBrandLiftStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Study canonical identifier to filter with. Either one of studyIdFilters or advertiserId should be provided.","explode":false,"in":"query","name":"studyIdFilters","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"The advertiser canonical identifier. Either one of studyIdFilters or advertiserId should be provided.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPBrandLiftStudiesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPBrandLiftStudiesV1M1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPBrandLiftStudiesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPBrandLiftStudiesV1M1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets one or more DSP BRAND_LIFT studies with requested study identifiers or an advertiser identifier.","tags":["Measurement"]},"post":{"description":"Create new DSP BRAND_LIFT studies.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CreateDSPBrandLiftStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1M1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1M1"},"maxItems":1,"minItems":1,"type":"array"}}},"description":"An array of study objects. For each object, specify required fields and their values. Maximum length of the array is 1."},"responses":{"207":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"422":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unprocessable Entity - The syntax of the request is correct, but the server was unable to process the contained instructions."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Create new DSP BRAND_LIFT studies.","tags":["Measurement"]},"put":{"description":"Update DSP BRAND_LIFT studies. This will be a full update.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"UpdateDSPBrandLiftStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1M1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPBrandLiftStudyV1M1"},"maxItems":1,"minItems":1,"type":"array"}}},"description":"An array of measurement objects. For each object, specify required fields and their values. Maximum length of the array is 1."},"responses":{"207":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"422":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unprocessable Entity - The syntax of the request is correct, but the server was unable to process the contained instructions."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Update DSP BRAND_LIFT studies. This will be a full update.","tags":["Measurement"]}},"/dsp/measurement/studies/creativeTesting":{"get":{"description":"Gets one or more DSP CREATIVE_TESTING studies with requested study identifiers or an advertiser identifier.","operationId":"GetDSPCreativeTestingStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Study canonical identifier to filter with. Either one of studyIds or advertiserId should be provided.","explode":false,"in":"query","name":"studyIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"The advertiser canonical identifier. Either one of studyIds or advertiserId should be provided.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPCreativeTestingStudiesV1M2"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets one or more DSP CREATIVE_TESTING studies with requested study identifiers or an advertiser identifier.","tags":["Measurement"]},"post":{"description":"Create new DSP CREATIVE_TESTING study.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CreateDSPCreativeTestingStudy","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/CreateDSPCreativeTestingStudyV1M2"}}},"description":"Create object for DSP CREATIVE_TESTING study."},"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPCreativeTestingStudyV1M2"}}},"description":"Success."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad request."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."}},"summary":"Create new DSP CREATIVE_TESTING study.","tags":["Measurement"]}},"/dsp/measurement/studies/creativeTesting/{studyId}":{"put":{"description":"Update DSP CREATIVE_TESTING study. This will be a full update.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"UpdateDSPCreativeTestingStudy","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"The canonical identifier that represents a unique study.","in":"path","name":"studyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/UpdateDSPCreativeTestingStudyV1M2"}}},"description":"Update object for DSP CREATIVE_TESTING study."},"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/DSPCreativeTestingStudyV1M2"}}},"description":"Success."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad request."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."}},"summary":"Update DSP CREATIVE_TESTING study. This will be a full update.","tags":["Measurement"]}},"/dsp/measurement/studies/creativeTesting/{studyId}/result":{"get":{"description":"Get result of a DSP CREATIVE_TESTING study. Returns 200 successful response if json resource is requested in Accept header.","operationId":"GetDSPCreativeTestingStudyResult","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"The version(s) of the requested resource. Available version(s) - `application/vnd.measurementresult.v1.2+json`, `text/vnd.measurementresult.v1.2+csv`.","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The canonical identifier that represents a unique study.","in":"path","name":"studyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/CreativeTestingStudyResultV1M2"}}},"description":"Successful operation."},"307":{"description":"Successful operation for downloading result file."},"400":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Get result of a DSP CREATIVE_TESTING study.","tags":["Measurement"]}},"/dsp/measurement/studies/omnichannelMetrics":{"get":{"description":"Gets one or more DSP OMNICHANNEL_METRICS studies with requested study identifiers or an advertiser identifier.","operationId":"GetDSPOmnichannelMetricsStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Study canonical identifier to filter with. Either one of studyIds or advertiserId should be provided.","explode":false,"in":"query","name":"studyIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"The advertiser canonical identifier. Either one of studyIdFilters or advertiserId should be provided.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPOmnichannelMetricsStudiesV1M2"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/PaginatedDSPOmnichannelMetricsStudiesV1M3"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets one or more DSP OMNICHANNEL_METRICS studies with requested study identifiers or an advertiser identifier.","tags":["Measurement"]},"post":{"description":"Create new DSP OMNICHANNEL_METRICS studies.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"CreateDSPOmnichannelMetricsStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPOmnichannelMetricsStudyV1M2"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPOmnichannelMetricsStudyV1M3"},"maxItems":1,"minItems":1,"type":"array"}}},"description":"An array of study objects. For each object, specify required fields and their values. Maximum length of the array is 1."},"responses":{"207":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."}},"summary":"Create new DSP OMNICHANNEL_METRICS studies.","tags":["Measurement"]},"put":{"description":"Update DSP OMNICHANNEL_METRICS studies. This will be a full update.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\"]","operationId":"UpdateDSPOmnichannelMetricsStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPOmnichannelMetricsStudyV1M2"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"items":{"$ref":"#/components/schemas/DSPOmnichannelMetricsStudyV1M3"},"maxItems":1,"minItems":1,"type":"array"}}},"description":"An array of measurement objects. For each object, specify required fields and their values. Maximum length of the array is 1."},"responses":{"207":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Update DSP OMNICHANNEL_METRICS studies. This will be a full update.","tags":["Measurement"]}},"/dsp/measurement/studies/omnichannelMetrics/{studyId}/result":{"get":{"description":"Get result of a DSP OMNICHANNEL_METRICS study. Returns a 307 Temporary Redirect response if any of the file types is requested and response includes a location header with the value set to an AWS S3 p...","operationId":"GetDSPOmnichannelMetricsStudyResult","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"The version(s) of the requested resource. Available version(s) - `text/vnd.measurementresult.v1+xlsx`","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The canonical identifier that represents a unique study.","in":"path","name":"studyId","required":true,"schema":{"type":"string"}}],"responses":{"307":{"description":"Successful operation for downloading result file."},"400":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementresult.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Get result of a DSP OMNICHANNEL_METRICS study.","tags":["Measurement"]}},"/measurement/planning/eligibility":{"post":{"description":"Checks eligibility against all vendor products.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CheckPlanningEligibility","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/PlanningEligibilityRequestV1M3"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/PlanningEligibilityRequestV1M3"}}},"description":"Fetch measurement vendor products request object."},"responses":{"200":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/PlanningEligibilityResponseV1M3"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/PlanningEligibilityResponseV1M3"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementeligibility.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementeligibility.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Checks eligibility against all vendor products.","tags":["Measurement"]}},"/measurement/studies":{"delete":{"description":"Cancel existing studies.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CancelMeasurementStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Study canonical identifiers to cancel.","explode":false,"in":"query","name":"studyIds","required":false,"schema":{"items":{"type":"string"},"maxItems":1,"minItems":1,"type":"array"},"style":"form"}],"responses":{"207":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/StudyResponsesV1"}}},"description":"Multi-status."},"400":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Cancel existing studies. Once a study is cancelled it can not be resumed again.","tags":["Measurement"]},"get":{"description":"Gets base study objects given a list of studyIds or a list of advertiserIds.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"GetStudies","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Study canonical identifier to filter with. Either one of studyIds or advertiserId should be provided.","explode":false,"in":"query","name":"studyIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"The advertiser canonical identifier. Either one of studyIds or advertiserId should be provided.","in":"query","name":"advertiserId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseStudiesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseStudiesV1M1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseStudiesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/PaginatedBaseStudiesV1M1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets base study objects given a list of studyIds or a list of advertiserIds.","tags":["Measurement"]}},"/measurement/studies/brandLift/{studyId}/result":{"get":{"description":"Get result of a DSP BRAND_LIFT study. Returns 200 successful response if json resource is requested in Accept header.","operationId":"GetDSPBrandLiftStudyResult","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"The version(s) of the requested resource. Available version(s) - `application/vnd.measurementresult.v1+json`, `application/vnd.measurementresult.v1.1+json`, `text/vnd.measurementresult.v1+csv`","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The canonical identifier that represents a unique study.","in":"path","name":"studyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/BrandLiftStudyResultV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/BrandLiftStudyResultV1M1"}}},"description":"Successful operation."},"307":{"description":"Successful operation for downloading result file."},"400":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementresult.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementresult.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Get result of a DSP BRAND_LIFT study.","tags":["Measurement"]}},"/measurement/studies/surveys":{"get":{"description":"Gets one or more study surveys with requested survey identifiers or a study identifier.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"GetSurveys","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Survey canonical identifier to filter with. Either one of surveyIds or studyId should be provided.","explode":false,"in":"query","name":"surveyIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"A study canonical identifier. Either one of surveyIds or studyId should be provided.","in":"query","name":"studyId","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/PaginatedSurveysV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/PaginatedSurveysV1M1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedSurveysV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/PaginatedSurveysV1M1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets one or more study surveys with requested survey identifiers or a study identifier.","tags":["Measurement"]},"post":{"description":"Create new study surveys.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"CreateSurveys","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1M1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1M1"},"maxItems":1,"minItems":1,"type":"array"}}},"description":"An array of measurement objects. For each object, specify required fields and their values. Maximum length of the array is 1."},"responses":{"207":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Create new study surveys.","tags":["Measurement"]},"put":{"description":"Update measurement surveys. This will be a full update.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"UpdateSurveys","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"}],"requestBody":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1M1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1"},"maxItems":1,"minItems":1,"type":"array"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"items":{"$ref":"#/components/schemas/SurveyV1M1"},"maxItems":1,"minItems":1,"type":"array"}}},"description":"An array of survey objects. For each object, specify required fields and their values. Maximum length of the array is 1."},"responses":{"207":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/SurveyResponsesV1"}}},"description":"Multi-status."},"401":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.studymanagement.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.studymanagement.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Update measurement surveys. This will be a full update.","tags":["Measurement"]}},"/measurement/vendorProducts/list":{"post":{"description":"Lists the supported measurement vendors products.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"vendorProduct","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/VendorProductRequestV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/VendorProductRequestV1M1"}}},"description":"Fetch measurement vendor products request object."},"responses":{"200":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/PaginatedVendorProductsV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/PaginatedVendorProductsV1M1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Lists the supported measurement vendor products.","tags":["Measurement"]}},"/measurement/vendorProducts/omnichannelMetrics/brands/list":{"post":{"description":"Search for brands to be used in the OMNICHANNEL_METRICS vendor product.\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"omnichannelMetricsBrandSearch","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/profileHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","schema":{"type":"string"}},{"description":"Sets the maximum number of brands in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"requestBody":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/OmnichannelMetricsBrandSearchRequestV1M2"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/OmnichannelMetricsBrandSearchRequestV1M2"}}},"description":"Fetch measurement vendor products request object."},"responses":{"200":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/PaginatedOmnichannelMetricsBrandsV1M2"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/PaginatedOmnichannelMetricsBrandsV1M2"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.ocmbrands.v1.2+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.ocmbrands.v1.3+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Search for brands to be used in the OMNICHANNEL_METRICS vendor product.","tags":["Measurement"]}},"/measurement/vendorProducts/policies":{"get":{"description":"Gets the policies for the specific vendor product(s).\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"vendorProductPolicy","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Vendor product canonical identifier to filter with.","explode":false,"in":"query","name":"vendorProductIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/PaginatedVendorProductPoliciesV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/PaginatedVendorProductPoliciesV1M1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets the policies for the specific vendor product(s).","tags":["Measurement"]}},"/measurement/vendorProducts/surveyQuestionTemplates":{"get":{"description":"Gets the survey question templates for the specific vendor product(s).\n\n**Authorized resource type**:\nDSP Rodeo Entity ID, DSP Advertiser Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_view\"]","operationId":"vendorProductSurveyQuestionTemplates","parameters":[{"$ref":"#/components/parameters/clientHeader"},{"$ref":"#/components/parameters/advertiserIdHeader"},{"$ref":"#/components/parameters/profileHeader"},{"description":"Vendor product canonical identifier to filter with.","explode":false,"in":"query","name":"vendorProductIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"Vendor product survey question template identifier to filter with.","explode":false,"in":"query","name":"surveyQuestionTemplateIds","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"style":"form"},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the maximum number of studies in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,100] with default as 10.","in":"query","name":"maxResults","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/PaginatedSurveyQuestionTemplatesV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/PaginatedSurveyQuestionTemplatesV1M1"}}},"description":"Successful operation."},"400":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unauthenticated request."},"403":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/vnd.measurementvendor.v1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}},"application/vnd.measurementvendor.v1.1+json":{"schema":{"$ref":"#/components/schemas/ErrorV1"}}},"description":"Internal Server Error."}},"summary":"Gets the survey question templates for the specific vendor product(s).","tags":["Measurement"]}}}}