{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AdvertiserIdFilter":{"description":"Filter frequency groups by the list of advertiser ids.","properties":{"include":{"items":{"description":"The advertiser identifier.","type":"string"},"maxItems":1,"minItems":0,"type":"array"}},"type":"object"},"CreateFrequencyGroupRequestContentV1":{"properties":{"advertiserId":{"description":"The advertiser identifier of the advertiser who is creating the frequency groups. Used to prevent illegal operations on a FrequencyGroup.","type":"string"},"entityId":{"description":"The identifier of the entity who is creating the frequency groups. Used to prevent illegal operations on a FrequencyGroup.","type":"string"},"entityName":{"description":"The name of the entity who owns the frequency group","type":"string"},"frequencyGroupName":{"description":"The frequency group name.","type":"string"},"maxImpressions":{"description":"The maximum number of times an ad is displayed.","type":"number"},"timeUnit":{"$ref":"#/components/schemas/FrequencyGroupTimeUnitV1"},"timeUnitCount":{"description":"The time unit count.","type":"number"}},"required":["frequencyGroupName","maxImpressions","timeUnit","timeUnitCount"],"type":"object"},"CreateFrequencyGroupResponseContentV1":{"properties":{"advertiserId":{"description":"The advertiser identifier of the advertiser who is creating the frequency groups. Used to prevent illegal operations on a FrequencyGroup.","type":"string"},"entityId":{"description":"The identifier of the entity who is creating the frequency groups. Used to prevent illegal operations on a FrequencyGroup.","type":"string"},"entityName":{"description":"The name of the entity who owns the frequency group","type":"string"},"frequencyGroupId":{"description":"The frequency group identifier. Immutable field.","type":"string"},"frequencyGroupName":{"description":"The frequency group name.","type":"string"},"maxImpressions":{"description":"The maximum number of times an ad is displayed.","type":"number"},"status":{"$ref":"#/components/schemas/FrequencyGroupStatusV1"},"timeUnit":{"$ref":"#/components/schemas/FrequencyGroupTimeUnitV1"},"timeUnitCount":{"description":"The time unit count.","type":"number"}},"type":"object"},"CreateFrequencyGroupsV1":{"properties":{"frequencyGroups":{"items":{"$ref":"#/components/schemas/CreateFrequencyGroupRequestContentV1"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"CreatedFrequencyGroupsV1":{"properties":{"frequencyGroups":{"items":{"$ref":"#/components/schemas/CreateFrequencyGroupResponseContentV1"},"maxItems":1,"minItems":1,"type":"array"}},"type":"object"},"DspBadRequestExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspForbiddenExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspInternalServerExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspNotFoundExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspSubError":{"properties":{"errorCode":{"type":"string"},"errorId":{"type":"string"},"errorMessage":{"type":"string"}},"required":["errorCode","errorMessage"],"type":"object"},"DspTooManyRequestsExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnauthorizedExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"DspUnsupportedMediaTypeExceptionResponseContent":{"properties":{"errors":{"items":{"$ref":"#/components/schemas/DspSubError"},"maxItems":100,"minItems":1,"type":"array"},"requestId":{"type":"string"}},"type":"object"},"FrequencyGroupStatusV1":{"description":"The frequency group status. Set to active on successful creation of the frequency group.","enum":["ACTIVE","INACTIVE"],"type":"string"},"FrequencyGroupTimeUnitV1":{"enum":["DAYS","HOURS","MINUTES","OTHER"],"type":"string"},"FrequencyGroups":{"properties":{"frequencyGroups":{"items":{"$ref":"#/components/schemas/GetFrequencyGroupRequestContentV1"},"maxItems":100,"minItems":1,"type":"array"},"nextToken":{"type":"string"},"totalResults":{"description":"The total number of results returned by an operation.","type":"number"}},"type":"object"},"GetFrequencyGroupRequestContentV1":{"properties":{"advertiserId":{"description":"The advertiser identifier of the advertiser who is creating the frequency groups. Used to prevent illegal operations on a FrequencyGroup.","type":"string"},"entityId":{"description":"The identifier of the entity who is creating the frequency groups. Used to prevent illegal operations on a FrequencyGroup.","type":"string"},"entityName":{"description":"The name of the entity who owns the frequency group","type":"string"},"frequencyGroupId":{"description":"The frequency group identifier. Immutable field.","type":"string"},"frequencyGroupName":{"description":"The frequency group name.","type":"string"},"maxImpressions":{"description":"The maximum number of times an ad is displayed.","type":"number"},"status":{"$ref":"#/components/schemas/FrequencyGroupStatusV1"},"timeUnit":{"$ref":"#/components/schemas/FrequencyGroupTimeUnitV1"},"timeUnitCount":{"description":"The time unit count.","type":"number"}},"type":"object"},"ListFrequencyGroupsRequestContentV1":{"properties":{"advertiserIdFilter":{"$ref":"#/components/schemas/AdvertiserIdFilter"},"frequencyGroupIds":{"description":"The frequency group identifiers.","items":{"description":"The frequency group identifier.","maxLength":200,"minLength":1,"pattern":"^[^\"\\[\\]()\u003c\u003e\u003d!]+$","type":"string"},"maxItems":200,"minItems":0,"type":"array"},"frequencyGroupNameFilter":{"description":"Filters frequency groups by frequency group name.","maxLength":200,"minLength":0,"pattern":"^[^\"\\[\\]()\u003c\u003e\u003d!]*$","type":"string"},"maxResults":{"description":"Sets the maximum number of objects in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,200] with default as 20. For example, supplying maxResults\u003d20 with a previously returned token will fetch up to the next 20 items.In some cases, fewer items may be returned. Default max results is 20.","maximum":200,"minimum":1,"type":"number"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control the pagination of the returned array.","type":"string"},"statusFilter":{"$ref":"#/components/schemas/FrequencyGroupStatusV1"}},"type":"object"},"PatchFrequencyGroupRequestContentV1":{"properties":{"frequencyGroupName":{"description":"The frequency group name.","type":"string"},"maxImpressions":{"description":"The maximum number of times an ad is displayed.","type":"number"},"status":{"$ref":"#/components/schemas/FrequencyGroupStatusV1"},"timeUnit":{"$ref":"#/components/schemas/FrequencyGroupTimeUnitV1"},"timeUnitCount":{"description":"The time unit count.","type":"number"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"FM FrequencyGroup API","title":"D16GFMApiFrequencyGroupV1","version":"3.0"},"openapi":"3.0.1","paths":{"/frequencyGroups/v1":{"post":{"description":"Creates a frequency group with basic details and generates a frequency group identifier.\n\n**Authorized resource type**:\nGlobal Ad Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"advertiser_campaign_edit\"]\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\",\"advertiser_campaign_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"advertiser_campaign_edit\"]","operationId":"createFrequencyGroupV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFrequencyGroupsV1"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedFrequencyGroupsV1"}}},"description":"createFrequencyGroupV1 201 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"tags":["Frequency Group"]}},"/frequencyGroups/v1/list":{"post":{"description":"Gets a list of frequency groups for a given advertiser or entity.\n\n**Authorized resource type**:\nGlobal Ad Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"campaign_view\",\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]\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\",\"campaign_view\",\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"campaign_view\",\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"listFrequencyGroupsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","type":"string"}},{"description":"The identifier of a manager account.","in":"header","name":"Amazon-Ads-Manager-AccountId","schema":{"description":"The identifier of a manager account.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFrequencyGroupsRequestContentV1"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrequencyGroups"}}},"description":"listFrequencyGroupsV1 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"tags":["Frequency Group"]}},"/frequencyGroups/v1/{frequencyGroupId}":{"get":{"description":"Gets basic details for a frequency group given a frequency group identifier.\n\n**Authorized resource type**:\nGlobal Ad Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"campaign_view\",\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]\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\",\"campaign_view\",\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"campaign_view\",\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]","operationId":"getFrequencyGroupV1","parameters":[{"in":"path","name":"frequencyGroupId","required":true,"schema":{"type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"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.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFrequencyGroupRequestContentV1"}}},"description":"getFrequencyGroupV1 200 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"tags":["Frequency Group"]},"patch":{"description":"Updates a frequency group.\n\n**Authorized resource type**:\nGlobal Ad Account ID\n\n**Parameter name**:\nAmazon-Ads-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"advertiser_campaign_edit\"]\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\",\"advertiser_campaign_edit\"]\n\n**Authorized resource type**:\nGlobal Manager Account ID\n\n**Parameter name**:\nAmazon-Ads-Manager-AccountId\n\n**Parameter in**:\nheader\n\n**Requires one of these permissions**:\n[\"campaign_edit\",\"advertiser_campaign_edit\"]","operationId":"patchFrequencyGroupV1","parameters":[{"in":"path","name":"frequencyGroupId","required":true,"schema":{"type":"string"}},{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","in":"header","name":"Amazon-Ads-AccountId","schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID. Use Amazon-Ads-AccountId to get resources at advertiser level. Use Amazon-Advertising-API-Scope and leave     Amazon-Ads-AccountId empty to get resources at manager account level.","type":"string"}},{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","type":"string"}},{"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.","in":"header","name":"Amazon-Advertising-API-Scope","schema":{"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.","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchFrequencyGroupRequestContentV1"}}}},"responses":{"204":{"description":"patchFrequencyGroupV1 204 response"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspBadRequestExceptionResponseContent"}}},"description":"Bad Request or request body is not matching with input model."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnauthorizedExceptionResponseContent"}}},"description":"Unauthenticated request."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspForbiddenExceptionResponseContent"}}},"description":"Forbidden - Request failed because user is not authorized to access a resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspNotFoundExceptionResponseContent"}}},"description":"Not Found - Requested resource does not exist or is not visible for the authenticated user."},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspUnsupportedMediaTypeExceptionResponseContent"}}},"description":"Unsupported Media Type - Version not supported."},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspTooManyRequestsExceptionResponseContent"}}},"description":"Too Many Requests - Request was rate-limited. Retry later."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspInternalServerExceptionResponseContent"}}},"description":"Internal Server Error."}},"tags":["Frequency Group"]}}}}