Abfrage von Seller Products

SellerProducts können über den Endpunkt findSellerProducts abgefragt werden. Als Rückgabewert erhält man eine Liste von SellerProducts. Die Suchanfrage und die Ergebnismenge können über Parameter angepasst werden.

Limitieren der Ergebnismenge

Die Anzahl der zurückgegebenen SellerProducts kann über den Parameter limit angepasst werden. Standardmäßig ist die Ergebnismenge auf 50 Einträge beschränkt.

Aufsplitten der Ergebnismenge

Die Ergebnismenge kann mittels der Parameter limit und offset seitenweise ausgegeben werden. Dies kann vor allem bei sehr großen Ergebnismengen sinnvoll sein. Über die Parameter limit und offset gibt man hierzu an, wie viele Elemente pro Seite auszugeben sind und ab welchem Element mit der Ausgabe begonnen werden soll. Der Parameter offset ist dann für jede auszugebende Seite anzupassen.

Filtern

Für den Endpunkt findSellerProducts stehen folgende Filter zur Verfügung:

Name Beschreibung Beispiel
ids Ids von SellerProducts filter: { ids: “123abc” } oder filter: { channelIds: [“123abc”,”456def”,”789ghi”] }
channelIds Ids von Sendern filter: { channelIds: 1 } oder filter: { channelIds: [1,2,3] }
channelName Name eines Senders; nicht kontextsensitiv filter: { channelName: “Testsender” } oder filter: { channelName: “tEstsEndEr” }
filterOnSubstring standardmäßig deaktiviert; ermöglicht innerhalb von channelName das Filtern auf Teilstrings filter: { filterOnSubstring: true }
channelTypeIds Ids von Sendertypen filter: { channelTypeIds: 1 } oder filter: { channelTypeIds: [1,2,3] }
sellerIds Ids von Vermarktern filter: { sellerIds: “123abc” } oder filter: { sellerIds: [“123abc”,”456def”,”789ghi”] }
originSellerIds Originäre Ids von Vermarktern filter: { originSellerIds: 1 } oder filter: { originSellerIds: [1,2,3] }
ediNumbers Edi-Nummern von Vermarktern filter: { ediNumbers: “1” } oder filter: { ediNumbers: [“1”,”2”,”3”] }
categoryIds Ids von Kategorien filter: { categoryIds: 1 } oder filter: { categoryIds: [1,2,3] }
countryIsoCodes Ländercodes, ISO 3166 ALPHA-2 filter: { countryIsoCodes: “DE”} oder filter: { countryIsoCodes: [“DE”,”BE”,”FR”] }
dateRange Zeitraum, für den mindestens ein gültiger Tarifeintrag vorliegen muss; nur passende Tarife werden zurückgegeben filter: { dateRange: { from: “2023-01-30”, to: “2023-02-01” }}
nationalSeller falls angegeben, wird auf Eigenschaft nationaler Vermarkter gefiltert filter: { nationalSeller: true } oder filter: { nationalSeller: false }
regionalSeller falls angegeben, wird auf Eigenschaft regionaler Vermarkter gefiltert filter: { regionalSeller: true } oder filter: { regionalSeller: false }
onlyWithSeller standardmäßig deaktiviert; SellerProduct muss an einem Vermarkter gebunden sein filter: { onlyWithSeller: true }
onlyWithTariffs standardmäßig deaktiviert; SellerProduct muss Tarife enthalten filter: { onlyWithTariffs: true }
showOnlyBookable standardmäßig aktiviert; SellerProduct ist an einem freigeschalteten Vermarkter gebunden filter: { showOnlyBookable: false }
weekdays SellerProduct enthält Tarife für einen der angegebenen Wochentage; nur passende Tarife werden zurückgegeben filter: { weekdays: MONDAY } oder filter: { weekdays: [SATURDAY, SUNDAY] }

Info Hinweis:
Hinweis: Die Filter können beliebig miteinander kombiniert werden. Dies ermöglicht eine gezieltere Abfrage der Daten.

Beispiele

Beispiel 1

SellerProducts mit gültigen Tarifen an Samstagen und Sonntagen im August 2023. Die Ergebnismenge ist auf fünf Einträge begrenzt.

query findSellerProductsUsingDateFilter {
	pricing {
		findSellerProducts(
			filter: {dateRange: {from: "2023-08-01", to: "2023-08-31"}, weekdays: [SATURDAY, SUNDAY]}
			limit: 5
		) {
			id
			channel {
				id
				name
			}
			seller {
				id
				name
				ediNumber
				origin {
					id
				}
				regional
				national
			}
			tariffs {
				appliesFrom
				appliesTo
				channelAdvertisingForms {
					advertisingFormTypeId
				}
			}
		}
	}
}

Beispiel 2

SellerProducts deren Sender im Namen “ArD” enthalten. Die ersten fünf Treffer der Suche werden übersprungen und die Ergebnismenge ist auf 10 Einträge begrenzt.

query findSellerProductsUsingChannelNameFilter {
	pricing {
		findSellerProducts(
			filter: {channelName: "ArD", filterOnSubstring: true}
			limit: 10
			offset: 5
		) {
			id
			channel {
				id
				name
			}
			seller {
				id
				name
				ediNumber
				origin {
					id
				}
				regional
				national
			}
			tariffs {
				appliesFrom
				appliesTo
				channelAdvertisingForms {
					advertisingFormTypeId
				}
			}
		}
	}
}

Abfrage von Vermarktern (Sellers)

Vermarkter können über den Endpunkt findSellers abgefragt werden. Als Rückgabewert erhält man eine Liste von Vermarktern. Die Suchanfrage und die Ergebnismenge können über Parameter angepasst werden.

Limitieren der Ergebnismenge

Die Anzahl der zurückgegebenen Vermarkter kann über den Parameter limit angepasst werden. Standardmäßig ist die Ergebnismenge auf 50 Einträge beschränkt.

Aufsplitten der Ergebnismenge

Die Ergebnismenge kann mittels der Parameter limit und offset seitenweise ausgegeben werden. Dies kann vor allem bei sehr großen Ergebnismengen sinnvoll sein. Über die Parameter limit und offset gibt man hierzu an, wie viele Elemente pro Seite auszugeben sind und ab welchem Element mit der Ausgabe begonnen werden soll. Der Parameter offset ist dann für jede auszugebende Seite anzupassen.

Filtern

Für den Endpunkt findSellers stehen folgende Filter zur Verfügung:

Name Beschreibung Beispiel
ids Ids von Vermarktern filter: { ids: “123abc” } oder filter: { ids: [“123abc”,”456def”,”789ghi”] }
originIds Originäre Ids von Vermarktern filter: { originIds: 1 } oder filter: { originIds: [1,2,3] }
showOnlyBookable standardmäßig aktiviert; SellerProduct ist an einem freigeschalteten Vermarkter gebunden filter: { showOnlyBookable: false }

Info Hinweis:
Hinweis: Die Filter können beliebig miteinander kombiniert werden. Dies ermöglicht eine gezieltere Abfrage der Daten.

Beispiele

Beispiel 1

Vermarkter, die zur Nutzung der Buchungsplattform von audioXchange freigeschaltet sind und deren OriginId auf die übergebenen Werte passt.

query findSellersUsingOriginIdsFilter {
	pricing {
		findSellers(filter: {originIds: [123, 456, 789]}) {
			id
			name
			origin {
				id
			}
			bookable
		}
	}
}

Beispiel 2

Liste von Vermarkter. Diese müssen nicht zur Nutzung der Buchungsplattform von audioXchange freigeschaltet sein. Die ersten fünf Treffer der Suche werden übersprungen und die Ergebnismenge ist auf 10 Einträge begrenzt.

query findSellersUsingBookableFilter {
	pricing {
		findSellers(filter: {showOnlyBookable: false}, limit: 10, offset: 5) {
			id
			name
			origin {
				id
			}
			bookable
		}
	}
}

Abfrage von Sendern (Channels)

Sender können über den Endpunkt findChannels abgefragt werden. Als Rückgabewert erhält man eine Liste von Sendern. Die Suchanfrage und die Ergebnismenge können über Parameter angepasst werden.

Limitieren der Ergebnismenge

Die Anzahl der zurückgegebenen Sender kann über den Parameter limit angepasst werden. Standardmäßig ist die Ergebnismenge auf 50 Einträge beschränkt.

Aufsplitten der Ergebnismenge

Die Ergebnismenge kann mittels der Parameter limit und offset seitenweise ausgegeben werden. Dies kann vor allem bei sehr großen Ergebnismengen sinnvoll sein. Über die Parameter limit und offset gibt man hierzu an, wie viele Elemente pro Seite auszugeben sind und ab welchem Element mit der Ausgabe begonnen werden soll. Der Parameter offset ist dann für jede auszugebende Seite anzupassen.

Filtern

Für den Endpunkt findChannels stehen folgende Filter zur Verfügung:

Name Beschreibung Beispiel
ids Ids von Sendern filter: { ids: 1 } oder filter: { ids: [1,2,3] }
typeIds Ids von Sendertypen filter: { typeIds: 1 } oder filter: { typeIds: [1,2,3] }

Info Hinweis:
Hinweis: Die Filter können beliebig miteinander kombiniert werden. Dies ermöglicht eine gezieltere Abfrage der Daten.

Beispiele

Beispiel 1

Liste von Sendern, deren TypeIds auf eine der im Filter spezifizierten Ids passt. Die ersten fünf Treffer der Suche werden übersprungen und die Ergebnismenge ist auf 10 Einträge begrenzt.

query findChannelsUsingTypeIdFilter {
	pricing {
		findChannels(filter: {typeIds: [1,2,3]}, limit: 10, offset: 5) {
			id
			name
			typeId
			type
		}
	}
}

Abfrage der Zeiträume

Zeiträume können über den Endpunkt findPeriods abgefragt werden. Als Rückgabewert erhält man eine Liste von Zeiträumen. Die Suchanfrage und die Ergebnismenge können über Parameter angepasst werden.

Limitieren der Ergebnismenge

Die Anzahl der zurückgegebenen Zeiträume kann über den Parameter limit angepasst werden. Standardmäßig ist die Ergebnismenge auf 50 Einträge beschränkt.

Aufsplitten der Ergebnismenge

Die Ergebnismenge kann mittels der Parameter limit und offset seitenweise ausgegeben werden. Dies kann vor allem bei sehr großen Ergebnismengen sinnvoll sein. Über die Parameter limit und offset gibt man hierzu an, wie viele Elemente pro Seite auszugeben sind und ab welchem Element mit der Ausgabe begonnen werden soll. Der Parameter offset ist dann für jede auszugebende Seite anzupassen.

Filtern

Für den Endpunkt findPeriods stehen folgende Filter zur Verfügung:

Name Beschreibung Beispiel
channelIds Ids von Sendern filter: { channelIds: 1 } oder filter: { channelIds: [1,2,3] }
channelName Name eines Senders; nicht kontextsensitiv filter: { channelName: “Testsender” } oder filter: { channelName: “tEstsEndEr” }
dateRange Zeitraum, für den mindestens ein gültiger Tarifeintrag vorliegen muss; nur passende Tarife werden zurückgegeben filter: { dateRange: { from: “2023-01-30”, to: “2023-02-01” }}
ediNumbers Edi-Nummern von Vermarktern filter: { ediNumbers: “1” } oder filter: { ediNumbers: [“1”,”2”,”3”] }
periodIds Ids von Zeiträumen filter: { periodIds: 1 } oder filter: { periodIds: [1,2,3] }
sellerIds Ids von Vermarktern filter: { sellerIds: “123abc” } oder filter: { sellerIds: [“123abc”,”456def”,”789ghi”] }

Info Hinweis:
Hinweis: Die Filter können beliebig miteinander kombiniert werden. Dies ermöglicht eine gezieltere Abfrage der Daten.

Beispiele

Beispiel 1

Zeiträume mit gültigen Daten im August 2023. Die Ergebnismenge ist auf fünf Einträge begrenzt.

query findPeriodsUsingDateFilter {
	pricing {
		findPeriods(
			filter: {dateRange: {from: "2023-08-01", to: "2023-08-31"}}
			limit: 5
		) {
			periodId
			channel {
				id
				name
			}
			seller {
				id
				name
				ediNumber
				origin {
					id
				}
				regional
				national
			}
		}
	}
}

Beispiel 2

Zeiträume deren Sender den Namen “ARD MEDIA GmbH” tragen. Die ersten fünf Treffer der Suche werden übersprungen und die Ergebnismenge ist auf 10 Einträge begrenzt.

query findPeriodssUsingChannelNameFilter {
	pricing {
		findPeriods(
			filter: {channelName: "ARD MEDIA GmbH"}
			limit: 10
			offset: 5
		) {
			periodId
			appliesFrom
			appliesTo
			channel {
				id
				name
			}
			seller {
				id
				name
				ediNumber
				origin {
					id
				}
				regional
				national
			}
		}
	}
}

Abfrage von AlleTypen

AlleTypen können über den Endpunkt findAllTypes abgefragt werden. Als Rückgabewert erhält man eine Liste von AlleTypen.

Beispiele

Beispiel 1

Alle Einträge von Allgemeine Typen und Werbeformtypen.

query findAllTypes {
	pricing {
		findAllTypes {
			generalTypes {
				id
				designation
			}
			advertisingFormTypes {
				id
				designation
			}
		}
	}
}

Abfrage von Typenbereichen

Typenbereiche können über den Endpunkt findPeriods abgefragt werden. Als Rückgabewert erhält man eine Liste von Typenbereichen. Die Suchanfrage und die Ergebnismenge können über Parameter angepasst werden.

Limitieren der Ergebnismenge

Die Anzahl der zurückgegebenen Typenbereiche kann über den Parameter limit angepasst werden. Standardmäßig ist die Ergebnismenge auf 50 Einträge beschränkt.

Aufsplitten der Ergebnismenge

Die Ergebnismenge kann mittels der Parameter limit und offset seitenweise ausgegeben werden. Dies kann vor allem bei sehr großen Ergebnismengen sinnvoll sein. Über die Parameter limit und offset gibt man hierzu an, wie viele Elemente pro Seite auszugeben sind und ab welchem Element mit der Ausgabe begonnen werden soll. Der Parameter offset ist dann für jede auszugebende Seite anzupassen.

Filtern

Für den Endpunkt findTypeRanges stehen folgende Filter zur Verfügung:

Name Beschreibung Beispiel
ids Ids von Typenbereichen filter: { ids: 1 } oder filter: { ids: [1,2,3] }

Beispiele

Beispiel 1

Liste von Allgemeine Typen, deren Ids auf eine der im Filter spezifizierten Ids passt.

query findTypeRangesUsingIdFilter {
	pricing {
		findTypeRanges(filter: {ids: [1, 2, 3]}) {
			id
			designation
		}
	}
}

Abfrage von Informationen zum letzten Update

Informationen zum letzten Update der Daten des Pricing-Service können über den Endpunkt dateAge abgefragt werden.

Beispiele

Beispiel 1

Informationen zum letzten Update.

query findDateAge {
	pricing {
		dataAge {
			lastUpdate
			dirty
		}
	}
}