{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"AdsOwnerType":{"description":"If the frequency group belongs to a DSP entity or manager account, ownerType is MANAGER_ACCOUNT. If the frequency group belongs to a DSP advertiser, ownerType is ADVERTISER.","enum":["ADVERTISER","MANAGER_ACCOUNT"],"type":"string"},"CampaignFrequency":{"properties":{"maxImpressions":{"type":"number"},"timeUnit":{"$ref":"#/components/schemas/TimeUnitV1"},"timeUnitCount":{"type":"number"},"type":{"$ref":"#/components/schemas/CampaignType"}},"type":"object"},"CampaignType":{"enum":["CUSTOM","UNCAPPED"],"type":"string"},"CauseForAssociationUnavailability":{"enum":["ALREADY_ASSOCIATED","DELIVERY_STATUS_NOT_ACTIVE","TARGET_FREQUENCY"],"type":"string"},"DeliveryStatus":{"enum":["ACTIVE","ADS_NOT_RUNNING","ADVERTISER_NOT_RUNNING","BOOKING_REQUESTED","CAMPAIGN_NOT_RUNNING","CREATIVES_NOT_RUNNING","DELETED","ENDED","INACTIVE","NOT_APPROVED","OK","OUT_OF_BUDGET","PAUSED_BY_SYSTEM","PAUSED_BY_USER","PENDING_ADSERVER_RECEIPT","PREBOOK","PREBOOKED","PROPOSAL","READY_TO_RUN","RUNNING","UNINITIALIZED_BUDGET"],"type":"string"},"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"},"FrequencyGroupInput":{"properties":{"id":{"description":"The identifier of the frequency group.","type":"string"}},"required":["id"],"type":"object"},"FrequencyGroupWithAssociationOutput":{"properties":{"id":{"description":"The frequency group identifier.","type":"string"},"isTransitiveAssociation":{"description":"Return true, if the campaign is not directly associated to the frequency group, but the advertiser that the campaign belongs to is directly associated to the frequency group. Return false, if the campaign is directly associated to the frequency group.","type":"boolean"},"name":{"description":"The frequency group name.","type":"string"},"ownerId":{"description":"If the frequency group belongs to a DSP entity or manager account, ownerId is DSP entity id. If the frequency group belongs to a DSP advertiser, ownerId is DSP advertiser id.","type":"string"},"ownerType":{"$ref":"#/components/schemas/AdsOwnerType"}},"type":"object"},"KPI":{"enum":["COMBINED_ROAS","COMPLETION_RATE","CPA","CPC","CPD","CPDPV","CPFAO","CPI","CPVC","CTR","DPVR","INCREMENTAL_REACH","IOPS","NONE","OTHER","REACH","ROAS","TARGET_FREQUENCY","TOTAL_CPSU","TOTAL_ROAS"],"type":"string"},"ListAdvertiserAssociationResponseBaseObject":{"properties":{"id":{"description":"The advertiser identifier.","type":"string"},"name":{"description":"The advertiser name.","type":"string"}},"type":"object"},"ListAdvertiserFrequencyGroupAssociationResponseBaseObject":{"properties":{"id":{"description":"The frequency group identifier.","type":"string"},"name":{"description":"The frequency group name.","type":"string"},"ownerId":{"description":"If the frequency group belongs to a DSP entity or manager account, ownerId is DSP entity id. If the frequency group belongs to a DSP advertiser, ownerId is advertiser id.","type":"string"},"ownerType":{"$ref":"#/components/schemas/AdsOwnerType"}},"type":"object"},"ListAdvertisersBaseObject":{"properties":{"advertiserId":{"type":"string"},"advertiserName":{"type":"string"}},"type":"object"},"ListAdvertisersFrequencyGroupAssociationsBaseObject":{"properties":{"advertiser":{"$ref":"#/components/schemas/ListAdvertisersBaseObject"},"frequencyGroup":{"$ref":"#/components/schemas/ListAdvertisersFrequencyGroupBaseObject"}},"type":"object"},"ListAdvertisersFrequencyGroupAssociationsRequestContentV1":{"properties":{"advertiserNameFilter":{"description":"Allows the user to specify a name filter to limit the results by advertiser name","type":"string"},"frequencyGroupIdFilter":{"description":"A frequency group identifier to extract the advertiserIdFilter from; and empty string indicates that we are querying for all advertisers in the requesting entity","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,100] 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 value : 20","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the maxResults N parameter to control pagination of the returned array","type":"string"}},"type":"object"},"ListAdvertisersFrequencyGroupBaseObject":{"properties":{"frequencyGroupIds":{"items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"}},"type":"object"},"ListCampaignAssociationResponseBaseObject":{"properties":{"advertiserId":{"description":"The identifier of the advertiser that the campaign belongs to.","type":"string"},"id":{"description":"The campaign identifier.","type":"string"},"name":{"description":"The campaign name.","type":"string"}},"type":"object"},"ListCampaignsCampaignBaseObject":{"properties":{"advertiserId":{"type":"string"},"availableForFGAssociation":{"type":"boolean"},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"causeForAssociationUnavailability":{"items":{"$ref":"#/components/schemas/CauseForAssociationUnavailability"},"maxItems":10,"minItems":0,"type":"array"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"},"frequency":{"$ref":"#/components/schemas/CampaignFrequency"},"kpi":{"$ref":"#/components/schemas/KPI"}},"type":"object"},"ListCampaignsFrequencyGroupAssociationsRequestContentV1":{"properties":{"advertiserIdFilter":{"description":"The advertiser identifier","type":"string"},"campaignNameFilter":{"description":"Allows the user to specify a name filter to limit the results by campaign name","type":"string"},"frequencyGroupIdFilter":{"description":"A frequency group identifier to extract the advertiserIdFilter from","type":"string"},"includeTransitiveAssociations":{"description":"A campaign is transitively associated to a frequency group if the advertiser that this campaign belongs to is directly associated to the frequency group.","type":"boolean"},"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,100] 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 value : 20","maximum":100,"minimum":1,"type":"number"},"nextToken":{"description":"Token from a previous request. Use in conjunction with the maxResults N parameter to control pagination of the returned array","type":"string"}},"type":"object"},"ListCampaignsFrequencyGroupBaseObject":{"properties":{"frequencyGroupId":{"type":"string"}},"type":"object"},"ListCampaignsFrequencyGroupCampaignAssociationsBaseObject":{"description":"Campaign and associated frequency groups. frequencyGroup contains a frequency group belongs to DSP advertiser. frequencyGroups contains frequency groups belong to DSP entities.","properties":{"campaign":{"$ref":"#/components/schemas/ListCampaignsCampaignBaseObject"},"frequencyGroup":{"$ref":"#/components/schemas/ListCampaignsFrequencyGroupBaseObject"},"frequencyGroups":{"items":{"$ref":"#/components/schemas/FrequencyGroupWithAssociationOutput"},"maxItems":3,"minItems":0,"type":"array"}},"type":"object"},"ListFrequencyGroupAdvertiserAssociationRequestContentV1":{"properties":{"advertiserIds":{"description":"A list of advertiser identifiers.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"frequencyGroupIds":{"description":"A list of frequency group identifiers.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"includeTransitiveAssociations":{"description":"An advertiser is transitively associated to a frequency group if one of its campaigns is directly associated to the frequency group.","type":"boolean"},"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,100] with default as 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"}},"type":"object"},"ListFrequencyGroupAdvertiserAssociationResponseBaseObject":{"properties":{"advertiser":{"$ref":"#/components/schemas/ListAdvertiserAssociationResponseBaseObject"},"entityId":{"type":"string"},"entityName":{"type":"string"},"frequencyGroup":{"$ref":"#/components/schemas/ListAdvertiserFrequencyGroupAssociationResponseBaseObject"},"isTransitiveAssociation":{"description":"Return true, if the campaign is not directly associated to the frequency group, but the advertiser that the campaign belongs to is directly associated to the frequency group. Return false, if the campaign is directly associated to the frequency group.","type":"boolean"}},"type":"object"},"ListFrequencyGroupAssociationRequestContentV1":{"properties":{"campaignIds":{"description":"A list of campaign identifiers.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"frequencyGroupIds":{"description":"A list of frequency group identifiers.","items":{"type":"string"},"maxItems":100,"minItems":0,"type":"array"},"includeTransitiveAssociations":{"description":"A campaign is transitively associated to a frequency group if the advertiser that this campaign belongs to is directly associated to the frequency group.","type":"boolean"},"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,100] with default as 20.","maximum":100,"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"}},"type":"object"},"ListFrequencyGroupAssociationResponseBaseObject":{"properties":{"id":{"description":"The frequency group identifier.","type":"string"},"name":{"description":"The frequency group name.","type":"string"},"ownerId":{"description":"If the frequency group belongs to a DSP entity or manager account, ownerId is DSP entity id. If the frequency group belongs to a DSP advertiser, ownerId is advertiser id.","type":"string"},"ownerType":{"$ref":"#/components/schemas/AdsOwnerType"}},"type":"object"},"ListFrequencyGroupCampaignAssociationResponseBaseObject":{"properties":{"campaign":{"$ref":"#/components/schemas/ListCampaignAssociationResponseBaseObject"},"entityId":{"type":"string"},"entityName":{"type":"string"},"frequencyGroup":{"$ref":"#/components/schemas/ListFrequencyGroupAssociationResponseBaseObject"},"isTransitiveAssociation":{"description":"Return true, if the campaign is not directly associated to the frequency group, but the advertiser that the campaign belongs to is directly associated to the frequency group. Return false, if the campaign is directly associated to the frequency group.","type":"boolean"}},"type":"object"},"TimeUnitV1":{"enum":["DAYS","HOURS"],"type":"string"},"UpdateFrequencyGroupAdvertiserAssociationRequestContentV1":{"properties":{"frequencyGroupAdvertiserAssociations":{"items":{"$ref":"#/components/schemas/UpdateFrequencyGroupAdvertiserAssociationsBaseObject"},"maxItems":100,"minItems":1,"type":"array"}},"type":"object"},"UpdateFrequencyGroupAdvertiserAssociationsBaseObject":{"properties":{"advertiserId":{"description":"The advertiser identifier.","type":"string"},"frequencyGroupIds":{"description":"List of frequency groups identifiers to be associated. Represents the list of frequency groups associated to the advertiser after the operation, updating all existing associations for the advertiser.","items":{"type":"string"},"maxItems":20,"minItems":0,"type":"array"}},"required":["advertiserId"],"type":"object"},"UpdateFrequencyGroupAssociationsBaseObject":{"description":"Either frequencyGroupId or frequencyGroups should be provided, not both. Provide frequencyGroupId, if the frequency group belongs to a DSP advertiser. Provide frequencyGroups, if the frequency groups belong to a DSP entity or Manager Account.","properties":{"campaignId":{"description":"The campaign identifier of the campaign.","type":"string"},"frequencyGroupId":{"description":"The frequency group identifier of the frequency group to which campaign needs to be updated. The frequency group should belong to a DSP advertiser.","type":"string"},"frequencyGroups":{"description":"The list of frequency groups to which campaign needs to be updated. The frequency groups should belong to DSP entities.","items":{"$ref":"#/components/schemas/FrequencyGroupInput"},"maxItems":3,"minItems":0,"type":"array"}},"required":["campaignId"],"type":"object"},"UpdateFrequencyGroupAssociationsRequestContentV1":{"properties":{"frequencyGroupCampaignAssociations":{"items":{"$ref":"#/components/schemas/UpdateFrequencyGroupAssociationsBaseObject"},"maxItems":2000,"minItems":1,"type":"array"}},"type":"object"},"listAdvertisersFrequencyGroupAssociationsV1ResponseContent":{"properties":{"advertisers":{"items":{"$ref":"#/components/schemas/ListAdvertisersFrequencyGroupAssociationsBaseObject"},"maxItems":100,"minItems":0,"type":"array"},"entityId":{"type":"string"},"maxResults":{"type":"number"},"nextToken":{"type":"string"},"resultCount":{"type":"number"}},"type":"object"},"listCampaignsFrequencyGroupAssociationsV1ResponseContent":{"properties":{"advertiserId":{"type":"string"},"associations":{"items":{"$ref":"#/components/schemas/ListCampaignsFrequencyGroupCampaignAssociationsBaseObject"},"maxItems":200,"minItems":0,"type":"array"},"maxResults":{"type":"number"},"nextToken":{"type":"string"},"resultCount":{"type":"number"}},"type":"object"},"listFrequencyGroupAdvertiserAssociationsV1ResponseContent":{"properties":{"associations":{"description":"A list of frequency group to advertiser associations returned by the operation.","items":{"$ref":"#/components/schemas/ListFrequencyGroupAdvertiserAssociationResponseBaseObject"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"},"totalResults":{"description":"The total number of results returned by the operation.","type":"number"}},"type":"object"},"listFrequencyGroupCampaignAssociationsV1ResponseContent":{"properties":{"associations":{"description":"A list of frequency group to campaign associations returned by the operation.","items":{"$ref":"#/components/schemas/ListFrequencyGroupCampaignAssociationResponseBaseObject"},"maxItems":100,"minItems":0,"type":"array"},"nextToken":{"type":"string"},"totalResults":{"description":"The total number of results returned by the operation.","type":"number"}},"type":"object"}},"securitySchemes":{}},"info":{"description":"FM FrequencyGroupAssociation API V1","title":"D16GFMApiFrequencyGroupAssociationV1","version":"3.0"},"openapi":"3.0.1","paths":{"/frequencyGroups/v1/advertiserAssociations":{"put":{"description":"Updates the list of frequency group and advertiser associations for a given entity. Accepts a maximum of 100 entries. Campaigns with Target Frequency KPI or Incremental Reach KPI cannot be associated with frequency groups.\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\"]","operationId":"updateFrequencyGroupAdvertiserAssociationsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","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","required":true,"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/UpdateFrequencyGroupAdvertiserAssociationRequestContentV1"}}},"required":true},"responses":{"201":{"description":"updateFrequencyGroupAdvertiserAssociationsV1 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":["FrequencyGroupAssociation"]}},"/frequencyGroups/v1/advertiserAssociations/list":{"post":{"description":"Lists all associations between specified frequency groups or advertisers. Either a list of frequencyGroupIds or a list of advertiserIds should be provided, not both.\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\"]","operationId":"listFrequencyGroupAdvertiserAssociationsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","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","required":true,"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/ListFrequencyGroupAdvertiserAssociationRequestContentV1"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/listFrequencyGroupAdvertiserAssociationsV1ResponseContent"}}},"description":"listFrequencyGroupAdvertiserAssociationsV1 207 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":["FrequencyGroupAssociation"]}},"/frequencyGroups/v1/advertisers/list":{"post":{"description":"Provides a list of available advertisers and their frequency group association under an entity.\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\"]","operationId":"listAdvertisersFrequencyGroupAssociationsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","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","required":true,"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/ListAdvertisersFrequencyGroupAssociationsRequestContentV1"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/listAdvertisersFrequencyGroupAssociationsV1ResponseContent"}}},"description":"listAdvertisersFrequencyGroupAssociationsV1 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":["FrequencyGroupAssociation"]}},"/frequencyGroups/v1/campaignAssociations":{"put":{"description":"Updates the list of frequency group and campaign associations for a given advertiser. Accepts a maximum of 100 entries. Each entry represents the final association state for that campaign. If the frequency group is an empty string (\"campaignId\": \"id\", \"frequencyGroupId\": \"\"), the campaign will be disassociated; otherwise (\"campaignId\": \"id\", \"frequencyGroupId\": \"id\") the campaign and frequency group will be associated.\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\"]","operationId":"updateFrequencyGroupCampaignAssociationsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","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","required":true,"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/UpdateFrequencyGroupAssociationsRequestContentV1"}}},"required":true},"responses":{"204":{"description":"updateFrequencyGroupCampaignAssociationsV1 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":["FrequencyGroupAssociation"]}},"/frequencyGroups/v1/campaignAssociations/list":{"post":{"description":"Lists all associations between specified frequency groups or campaigns. Either a list of frequencyGroupIds or a list of campaignIds should be provided, not both.\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\"]","operationId":"listFrequencyGroupCampaignAssociationsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","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","required":true,"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/ListFrequencyGroupAssociationRequestContentV1"}}},"required":true},"responses":{"207":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/listFrequencyGroupCampaignAssociationsV1ResponseContent"}}},"description":"listFrequencyGroupCampaignAssociationsV1 207 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":["FrequencyGroupAssociation"]}},"/frequencyGroups/v1/campaigns/list":{"post":{"description":"Provides a list of available campaigns/orders and their frequency group association under an advertiser.\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\"]","operationId":"listCampaignsFrequencyGroupAssociationsV1","parameters":[{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","in":"header","name":"Amazon-Ads-AccountId","required":true,"schema":{"description":"Account identifier you use to access the DSP. This is your Amazon DSP Advertiser ID.","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","required":true,"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/ListCampaignsFrequencyGroupAssociationsRequestContentV1"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/listCampaignsFrequencyGroupAssociationsV1ResponseContent"}}},"description":"listCampaignsFrequencyGroupAssociationsV1 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":["FrequencyGroupAssociation"]}}}}