com.microsoft.bingads.v10.bulk.entities.BulkAdExtensionAssociation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsoft.bingads Show documentation
The Bing Ads Java SDK is a library improving developer experience when working with the Bing Ads services by providing high-level access to features such as Bulk API, OAuth Authorization and SOAP API.
There is a newer version: 13.0.23.2
Show newest version
package com.microsoft.bingads.v10.bulk.entities;

import com.microsoft.bingads.v10.internal.bulk.StringExtensions;
import com.microsoft.bingads.v10.internal.bulk.StringTable;
import com.microsoft.bingads.v10.campaignmanagement.AdExtensionEditorialStatus;
import com.microsoft.bingads.v10.campaignmanagement.AdExtensionIdToEntityIdAssociation;
import com.microsoft.bingads.v10.internal.bulk.BulkMapping;
import com.microsoft.bingads.v10.internal.bulk.MappingHelpers;
import com.microsoft.bingads.v10.internal.bulk.RowValues;
import com.microsoft.bingads.v10.internal.bulk.SimpleBulkMapping;
import com.microsoft.bingads.v10.internal.bulk.entities.SingleRecordBulkEntity;
import com.microsoft.bingads.internal.functionalinterfaces.BiConsumer;
import com.microsoft.bingads.internal.functionalinterfaces.Function;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Reserved for internal use. This abstract class provides properties that are shared by all bulk ad extension association classes.
 *
 * 
 * For more information, see Bulk File Schema at
 * http://go.microsoft.com/fwlink/?LinkID=620269.
 * 
 */
public abstract class BulkAdExtensionAssociation extends SingleRecordBulkEntity {

    private Status status;

    private AdExtensionIdToEntityIdAssociation adExtensionIdToEntityIdAssociation;

    private PerformanceData performanceData;

    private AdExtensionEditorialStatus editorialStatus;

    private static final List> MAPPINGS;

    static {
        List> m = new ArrayList>();

        m.add(new SimpleBulkMapping(StringTable.Status,
                new Function() {
                    @Override
                    public String apply(BulkAdExtensionAssociation c) {
                        return c.getStatus() != null ? c.getStatus().value() : null;
                    }
                },
                new BiConsumer() {
                    @Override
                    public void accept(String v, BulkAdExtensionAssociation c) {
                        c.setStatus(StringExtensions.parseOptional(v, new Function() {
                            @Override
                            public Status apply(String value) {
                                return Status.fromValue(value);
                            }
                        }));
                    }
                }
        ));

        m.add(new SimpleBulkMapping(StringTable.Id,
                new Function() {
                    @Override
                    public Long apply(BulkAdExtensionAssociation c) {
                        return c.getAdExtensionIdToEntityIdAssociation().getAdExtensionId();
                    }
                },
                new BiConsumer() {
                    @Override
                    public void accept(String v, BulkAdExtensionAssociation c) {
                        c.getAdExtensionIdToEntityIdAssociation().setAdExtensionId(StringExtensions.parseOptional(v, new Function() {
                            @Override
                            public Long apply(String value) {
                                return Long.parseLong(value);
                            }
                        }));
                    }
                }
        ));

        m.add(new SimpleBulkMapping(StringTable.ParentId,
                new Function() {
                    @Override
                    public Long apply(BulkAdExtensionAssociation c) {
                        return c.getAdExtensionIdToEntityIdAssociation().getEntityId();
                    }
                },
                new BiConsumer() {
                    @Override
                    public void accept(String v, BulkAdExtensionAssociation c) {
                        c.getAdExtensionIdToEntityIdAssociation().setEntityId(StringExtensions.parseOptional(v, new Function() {
                            @Override
                            public Long apply(String value) {
                                return Long.parseLong(value);
                            }
                        }));
                    }
                }
        ));

        m.add(new SimpleBulkMapping(StringTable.EditorialStatus,
                new Function() {
                    @Override
                    public String apply(BulkAdExtensionAssociation t) {
                        return t.getEditorialStatus() != null ? t.getEditorialStatus().value() : null;
                    }
                },
                new BiConsumer() {
                    @Override
                    public void accept(String v, BulkAdExtensionAssociation c) {
                        c.setEditorialStatus(StringExtensions.parseOptional(v, new Function() {
                            @Override
                            public AdExtensionEditorialStatus apply(String value) {
                                return AdExtensionEditorialStatus.fromValue(value);
                            }
                        }));
                    }
                }
        ));

        MAPPINGS = Collections.unmodifiableList(m);
    }

    @Override
    public void processMappingsToRowValues(RowValues values, boolean excludeReadonlyData) {
        validatePropertyNotNull(getAdExtensionIdToEntityIdAssociation(), "AdExtensionIdToEntityIdAssociation");

        MappingHelpers.convertToValues(this, values, MAPPINGS);

        if (!excludeReadonlyData) {
            PerformanceData.writeToRowValuesIfNotNull(performanceData, values);
        }
    }

    @Override
    public void processMappingsFromRowValues(RowValues values) {
        setAdExtensionIdToEntityIdAssociation(new AdExtensionIdToEntityIdAssociation());

        MappingHelpers.convertToEntity(values, MAPPINGS, this);

        performanceData = PerformanceData.readFromRowValuesOrNull(values);
    }

    /**
     * Gets the status of the ad extension association.
     *
     * 
     *     The value is Active if the EntityId and AdExtensionId are associated.
     *     The value is Deleted if the association is removed.
     *     Corresponds to the 'Status' field in the bulk file.
     * 
     */
    public Status getStatus() {
        return status;
    }

    /**
     * Sets the status of the ad extension association.
     *
     * 
     *     The value is Active if the EntityId and AdExtensionId are associated.
     *     The value is Deleted if the association is removed.
     *     Corresponds to the 'Status' field in the bulk file.
     * 
     */
    public void setStatus(Status status) {
        this.status = status;
    }

    /**
     * Gets the editorial status of the ad extension and associated entity.
     *
     * 
     *     For more information, see AdExtensionEditorialStatus at
     *     http://go.microsoft.com/fwlink/?LinkId=620284.
     *
     *     Corresponds to the 'Editorial Status' field in the bulk file.
     * 
     */
    public AdExtensionEditorialStatus getEditorialStatus() {
        return editorialStatus;
    }

    /**
     * Sets the editorial status of the ad extension and associated entity.
     *
     * 
     *     For more information, see AdExtensionEditorialStatus at
     *     http://go.microsoft.com/fwlink/?LinkId=620284.
     *
     *     Corresponds to the 'Editorial Status' field in the bulk file.
     * 
     */
    void setEditorialStatus(AdExtensionEditorialStatus editorialStatus) {
        this.editorialStatus = editorialStatus;
    }

    /**
     * Gets an association relationship between an ad extension and a supported entity, for example a campaign or ad group.
     */
    public AdExtensionIdToEntityIdAssociation getAdExtensionIdToEntityIdAssociation() {
        return adExtensionIdToEntityIdAssociation;
    }

    /**
     * Sets an association relationship between an ad extension and a supported entity, for example a campaign or ad group.
     */
    public void setAdExtensionIdToEntityIdAssociation(AdExtensionIdToEntityIdAssociation adExtensionIdToEntityIdAssociation) {
        this.adExtensionIdToEntityIdAssociation = adExtensionIdToEntityIdAssociation;
    }
}