Scope3 Advertisers API is one of 51 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Advertisers. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
22 operations
across 18 paths,
and defines 62 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, https://api.interchange.io/api/v2/buyer.
The identity and technical contract details declared by the specification.
AzureBlobAuthInput
object
How Scope3 authenticates to the buyer-owned Azure Blob container. SASTOKEN uses a container-scoped Shared Access Signature.
DeliveryConfigOutput
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
AvailableAccountListResponse
object
Response containing a list of available accounts from a partner
4 properties
2 required
FrequencyCapWindow
object
Rolling time window over which maximpressions applies (AdCP Duration shape).
2 properties
2 required
RevalidateDataDeliveryCredentialResponse
object
Updated credential after re-running the destination Probe.
1 property
1 required
UpdateReportingBucketBody
object
Request body for updating the offline reporting bucket on a linked partner account
1 property
1 required
LinkedAccountInput
object
An account to link to the advertiser
5 properties
3 required
GcsCredentialConfig
object
2 properties
2 required
AudienceListResponse
object
Paginated list of audience summaries
4 properties
4 required
Advertiser
object
Advertiser resource representation
17 properties
9 required
RemoveMember
object
Member to remove from the audience
4 properties
1 required
ReportingBucket
object
Customer-owned object storage bucket where sales agents can write offline delivery reports
8 properties
3 required
AudienceItem
object
Audience to sync with member changes
6 properties
1 required
S3CredentialConfigOutput
object
3 properties
3 required
GcsDeliveryConfigOutput
object
3 properties
3 required
FrequencyCapConfigInput
object
Frequency cap entry supplied inside a parent advertiser/campaign/creative request body. On PUT, the full array replaces all existing caps for that target.
2 properties
2 required
SyncAudiencesResponse
object
Audience sync accepted for async processing
4 properties
4 required
AssignAccountBody
object
Request body for assigning a source account to an advertiser
5 properties
3 required
ErrorResponse
object
Standard error response
2 properties
2 required
OptimizationApplyMode
string
Whether optimization suggestions are automatically applied or require human approval.
DataDeliveryCredential
object
Resolved Data Delivery Credential as returned by the API.
10 properties
7 required
BrandManifestJson
object
Full brand.json profile conforming to the ADCP v2 schema
15 properties
1 required
AzureBlobAuthStored
object
GcsDeliveryConfig
object
3 properties
1 required
DataDeliveryOutputInput
object
A single Data Delivery Output entry. Used inline on advertiser/campaign create+update.
6 properties
4 required
AdvertiserSummary
object
Compact advertiser view returned by list endpoints. Use getadvertiser for the full resource.
11 properties
9 required
AudienceSummary
object
Compact audience view returned by list endpoints. Use getaudience for the full resource.
9 properties
9 required
FrequencyCapConfig
object
Buyer-side frequency cap configuration
8 properties
7 required
DeliveryConfig
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
AccountOutput
object
Linked account resource on a partner platform
14 properties
7 required
AccountUnlinked
object
1 property
1 required
LinkedAccount
object
A partner account linked to this advertiser
8 properties
7 required
BuyerCredentialSourceRef
object
A storefront/source pair that a single credential row gives the buyer access to
4 properties
4 required
AdvertiserListResponse
object
Response containing a paginated list of advertiser summaries
5 properties
4 required
AccountListResponse
object
Response containing a paginated list of linked-account summaries
2 properties
2 required
AvailableAccountOutput
object
Discovered account available to be linked to an advertiser
9 properties
3 required
AccountResponse
object
Response containing a single linked account
1 property
1 required
DataDeliveryCredentialArrayInput
array
Array of Data Delivery Credentials for one advertiser. Names must be unique within the array.
DataDeliveryOutput
object
Resolved Data Delivery Output as returned by the API.
11 properties
10 required
GcsCredentialConfigOutput
object
2 properties
2 required
AzureBlobCredentialConfigInput
object
4 properties
4 required
AzureBlobDeliveryConfigOutput
object
3 properties
3 required
FrequencyCapTargetLevel
string
Level of the entity the frequency cap applies to
AzureBlobDeliveryConfig
object
3 properties
1 required
AzureBlobSasAuthInput
object
2 properties
2 required
CreateAdvertiserBody
object
Request body for creating a new advertiser
11 properties
3 required
S3CredentialConfig
object
3 properties
3 required
UpdateAdvertiserBody
object
Request body for updating an advertiser
10 properties
DataDeliveryOutputArrayInput
array
Array of Data Delivery Outputs for one scope (advertiser or campaign). At most one Output per (dataDeliveryType, credentialName) pair — the same data type can…
AzureBlobCredentialConfig
object
4 properties
4 required
CredentialConfig
object
Destination-specific auth target as stored on the credential row. AZUREBLOB omits the SAS token — the token lives in Google Secret Manager and is fetched at pr…
SyncAudiencesBody
object
Sync audience data into Scope3
3 properties
1 required
AdvertiserDataDelivery
object
Data-delivery configuration for this advertiser. Groups standing Data Delivery Outputs and the credentials they reference. Distinct from media-buy reporting fi…
2 properties
ApiError
object
Structured error object
4 properties
2 required
AdvertiserDataDeliveryInput
object
Data-delivery configuration for this advertiser. Groups standing Data Delivery Outputs and the credentials they reference. Distinct from media-buy reporting fi…
2 properties
CredentialConfigInput
object
Destination-specific auth target as submitted by the buyer. AZUREBLOB carries the SAS token; the API persists it to Google Secret Manager and stores only a ref…
AzureBlobSasAuthStored
object
1 property
1 required
S3DeliveryConfig
object
3 properties
1 required
AdvertiserAccount
object
13 properties
12 required
DataDeliveryCredentialInput
object
A single Data Delivery Credential entry. Used inline on advertiser create+update; full-replace by name within one request.
2 properties
2 required
S3DeliveryConfigOutput
object
3 properties
3 required
AccountSummary
object
Compact linked-account view returned by list endpoints. Use getadvertiseraccount for the full resource.
8 properties
7 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Scope3 publishes across the network.
