10. Dezember 2020

· Whitepaper

GetImagesOfCampaign

Inhaltsverzeichnis

xx Kapitel

Bilder einer Kampagne auslesen

Request Parameter: GetImagesOfCampaignRequest
Response Parameter: GetImagesOfCampaignResponse

Die Methode GetImagesOfCampaign liefert eine Liste von Bildern die in der Kampagne verwendet wurden.
Bis auf den SecurityContext und die CampaignId sind beim Request keine weiteren Angaben nötig. Die Methode liefert ein GetImagesOfCampaignResponse-Objekt, welches eine Liste von Images beinhaltet. Jedes Element der Liste repräsentiert ein Bild das in der Kampagne verwendet wurde.

Für das Auslesen stehen folgende Klassen zur Verfügung:

GetImagesOfCampaign

Response/Request

GetImagesOfCampaignRequest: Zur Definition, von welcher Kampagne die Bilder ausgelesen werden sollen.
GetImagesOfCampaignResponse: Beinhaltet eine Liste von ImageOfCampaign-Objekten, welche den in  GetImagesOfCampaignRequestbeschriebenen Kampagnen-ID entspricht.

ImageOfCampaign

FieldId: Ist die Id eines Feldes in der Kampagne.
ImageId: Die Id eines Bildes.
ImageUrl: Der relative Pfad des Bildes.
IsSingletonField: Gibt an ob das Bild in einem SingeltonField (kann nur einmal vorkommen in einer Kampagne) verwendet wird.
SectionId: Die Id eines Abschnittes in einer Kampagne.

Beispiel Request „Bilder auslesen“

C#

//Create a instance of the service Agent.
MailworxWebServiceAgent agent = new MailworxWebServiceAgent();
GetImagesOfCampaignRequest request = new GetImagesOfCampaignRequest();
//Set the auth. Information
request.SecurityContext = GetSecurityContext();
//Get the images.
GetImagesOfCampaignResponse response = agent.GetImagesOfCampaign(request);

foreach(var img in response.Images){
     Console.WriteLine(“FieldId: “ + img.FieldId.ToString());	
     Console.WriteLine(“ImageId:“ + img.ImageId.ToString());
     Console.WriteLine(“ImageUrl:“ + img.ImageUrl);
     Console.WriteLine(“IsSingeltonField:“ + img.IsSingletonField);
     Console.WriteLine(“SectionId:“ + img.SectionId.ToString());
}