开发人员指南概述

亚马逊广告 API 概览

如何创建并更新订单项

前提条件

如果您还未满足前提条件,则必须完成本教程的前提条件部分的操作

在本教程中,您需要提供以下信息:

每个订单项(Line Item)都必须与一个订单相关联。在创建订单项时,您需要指定与创建的订单项关联的订单标识符。您将使用订单资源 来检索此标识符。

您还需要与商品品类标识符(product category identifier)相关联的值,因为订单项必须与一个或多个商品品类相关联。您必须使用商品品类标识符,因为它们会传递至广告交易平台,并且亚马逊会使用它们来确定广告活动是否符合投放条件。您将使用商品品类资源来检索商品品类标识符。

在创建订单项时,还可以添加一组可选字段:

广告库存来源标识符

广告库存来源标识符(supply source identifier)标用于指定投放此订单项的广告库存。默认情况下,该订单项将在所有可用的实时竞价广告交易平台、亚马逊自有网站和亚马逊出版商服务广告库存中投放。

您将使用广告库存来源资源来检索广告库存来源标识符列表。

请注意,lineItemTypesupplySource 类型是必需的参数。当广告库存来源类型设置为 deal 时,需要输入 orderId 的值。响应中的交易广告库存来源列表经过筛选后将仅包含对拥有订单且仅在订单日期内投放的广告主有效的交易广告库存来源。

地理位置标记标识符

您可以使用地理位置标记标识符(geo location tagging identifier)来包含或排除与某个位置相关联的用户。位置将基于每个用户的亚马逊账单地址邮政编码。如果未提供邮政编码,则改用每个用户的 IP 地址。

您将使用地理位置资源来检索用于订单项投放的标识符。

地理位置资源让您能够通过标识符或文本查询(例如城市名称、邮政编码或其他地址文本)来检索标识符。

受众标识符

您可以检索可能的受众细分标识符(audience segment identifier)列表,这些标识符用于在创建订单项期间指定投放内容。

您将使用受众资源 来检索列表。

注意

如果您选择了任何场内客群、生活方式受众和/或汽车用品细分,则将对订单项收取定向费用。亚马逊建议在合并适用不同费用的细分时设置单独的订单项,因为整个订单项将适用最高费用。

第三方竞价前投放

您可以检索可能与具有第三方数据提供商链接的账户关联的自定义内容相关投放细分列表。

您将使用竞价前投放资源 来检索可能的自定义内容相关投放细分列表。目前,支持的两个提供商分别是 doubleVerifyoracleDataCloud

IAB 内容类别

您还可以通过扫描目标投放网站的内容,根据主题来进行网站投放。这样可以确保广告投放到相关站点,而不会投放到不适合的内容旁边。

您将使用 IAB 内容类别资源 来检索 IAB 内容类别标识符。

注意

这一设置不适用于亚马逊自有自营网站,因为这些网站会忽略所选的内容类别。对于视频订单项,使用这种投放方式会阻止向第三方移动应用投放广告。如果您想在移动应用上投放广告,请不要使用这种投放并设置单独的订单项。

域列表标识符

您可以使用域列表资源 来获取域资源标识符(domain resource identifier)列表,这些标识符可在创建订单项期间用于投放。

创建订单项

您将使用订单项资源 中的 POST 操作来创建订单项。创建订单项时需要提供以下参数:

订单项请求的示例类似于以下内容:

[
    {
        "lineItemType": "STANDARD_DISPLAY",
        "name": "This is my user friendly LineItem Name",
        "orderId": 5155*****0601,
        "externalId": "This is my external Id to uniquely identify this resource",
        "startDateTime": "2021-12-11 05:00:00 UTC",
        "endDateTime": "2021-12-19 02:59:00 UTC",
        "comments": "Additional Comments",
        "lineItemClassification": {
            "productCategories": [
                "3512**********2141",
                "3506**********6463",
                "3156**********1919"            
             ]
        },
        "frequencyCap": {
            "type": "CUSTOM",
            "maxImpressions": 3,
            "timeUnitCount": 5,
            "timeUnit": "DAYS"
        },
        "targeting": {
            "standardDisplayTargeting": {
                "userLocationTargeting": "US",
                "segmentTargeting": {
                    "segmentGroups": [
                        {
                            "segments": [
                                {
                                    "segmentId": "4116**********8920"
                                },
                                {
                                    "segmentId": "3945**********8988"
                                }
                            ],
                            "intraOperator": "AND",
                            "interOperator": "ALL"
                        },
                        {
                            "segments": [
                                {
                                    "segmentId": "4307**********8675"
                                },
                                {
                                    "segmentId": "3670**********5734"
                                }
                            ],
                            "intraOperator": "OR",
                            "interOperator": "ANY"
                        }
                    ]
                },
                "amazonViewabilityTargeting": {
                    "viewabilityTier": "VIEWABILITY_TIER_GT_60",
                    "includeUnmeasurableImpressions": true
                },
                "thirdPartyPreBidTargeting": {
                    "doubleVerify": {
                        "brandSafety": {
                            "highSeverityContent": [
                                "ADULT_CONTENT",
                                "DRUGS_SUBSTANCES",
                                "EXTREME_GRAPHICS_VIOLENCE_WEAPONS",
                                "HATE_SPEECH_PROFANITY",
                                "ILLEGAL_ACTIVITIES",
                                "INCENTIVIZED_MALWARE_CLUTTER",
                                "PIRACY_COPYRIGHT_INFRINGEMENT"
                            ],
                            "mediumSeverityContent": [
                                "AD_SERVER",
                                "ADULT_CONTENT",
                                "CELEBRITY_GOSSIP",
                                "CULTS_SURVIVALISM",
                                "DISASTER_AVIATION",
                                "DISASTER_MAN_MADE",
                                "DISASTER_NATURAL",
                                "DISASTER_TERRORISTS_EVENTS",
                                "DISASTER_VEHICLE",
                                "DRUGS_ALCOHOL",
                                "DRUGS_SMOKING",
                                "GAMBLING",
                                "INFLAMMATORY_POLITICS_NEWS",
                                "NEGATIVE_NEWS_FINANCIAL",
                                "NEGATIVE_NEWS_PHARMACEUTICAL",
                                "NON_STANDARD_CONTENT_NON_ENGLISH",
                                "NON_STANDARD_CONTENT_PARKING_PAGE",
                                "OCCULT",
                                "SEX_EDUCATION",
                                "UNMODERATED_UGC_FORUMS_IMAGES_VIDEO"
                            ],
                            "unknownContent": true
                        },
                        "fraudInvalidTraffic": {
                            "excludeImpressions": true,
                            "excludeAppsAndSites": "FRAUD_TRAFFIC_LEVEL_GTE_50",
                            "blockAppAndSites": true
                        },
                        "authenticBrandSafety": {
                            "doubleVerifySegmentId": "514**434"
                        },
                        "viewability": {
                            "mrcViewabilityTargeting": "MRC_VIEWABILITY_GTE_80",
                            "brandExposureViewabilityTargeting": "BRAND_EXPOSURE_VIEWABILITY_GTE_15_SEC_AVG_DURATION",
                            "includeUnmeasurableImpressions": true
                        },
                        "customContextualSegmentId": "520**712"
                    },
                    "oracleDataCloud": {
                        "brandSafety": {
                            "targetingOption": "ESSENTIAL_PROTECTION",
                            "essentialProtection": [
                                "ADULT",
                                "ARMS",
                                "CRIME",
                                "INJURY",
                                "PIRACY",
                                "DRUGS",
                                "HATE_SPEECH",
                                "MILITARY",
                                "OBSCENITY",
                                "TERRORISM",
                                "TOBACCO"
                            ]
                        },
                        "fraudInvalidTraffic": "FRAUD_INVALID_TRAFFIC_MAXIMUM_PROTECTION",
                        "customSegmentId": "255**888",
                        "contextualPredictsSegmentId": "259**212"
                    },
                    "integralAdScience": {
                        "brandSafety": {
                            "iasBrandSafetyAdult": "BRAND_SAFETY_EXCLUE_HIGH_RISK",
                            "iasBrandSafetyAlcohol": "ALLOW_ALL",
                            "iasBrandSafetyGambling": "ALLOW_ALL",
                            "iasBrandSafetyHateSpeech": "BRAND_SAFETY_EXCLUE_HIGH_AND_MODERATE_RISK",
                            "iasBrandSafetyIllegalDownloads": "ALLOW_ALL",
                            "iasBrandSafetyIllegalDrugs": "ALLOW_ALL",
                            "iasBrandSafetyOffensiveLanguage": "ALLOW_ALL",
                            "iasBrandSafetyViolence": "ALLOW_ALL",
                            "excludeContent": true
                        },
                        "fraudInvalidTraffic": "FRAUD_INVALID_TRAFFIC_EXCLUDE_HIGH_RISK",
                        "viewability": {
                            "standard": "PUBLICIS",
                            "viewabilityTargeting": "VIEWABILITY_TIER_GT_60"
                        }
                    }
                },
                "supplyTargeting": {
                    "supplySourceTargeting": {
                        "supplySources": [
                            "3156**********8896",
                            "2997**********6584",
                            "3576**********8825",
                            "3497**********8740",
                            "3242**********7683"
                        ]
                    }
                },
                "geoLocationTargeting": {
                    "locationTargetingBy": "IPADDRESS_POSTALCODE",
                    "inclusions": [
                        "XHvCjcKHXmJ7woVowo7CjmvCln5swozCncKawrLCrsKoZQ=="
                    ],
                    "exclusions": [
                        "XHvCjcKHXsKUwotpwonCkg=="
                    ]
                },
                "dayPartTargeting": {
                    "timeZonePreference": "AD_SERVER_TIMEZONE",
                    "dayParts": [
                        {
                            "hourSlots": [
                                0,
                                1,
                                2,
                                3,
                                4,
                                5,
                                6,
                                7,
                                8,
                                9,
                                10,
                                11,
                                12,
                                13,
                                14,
                                16,
                                17,
                                18,
                                19,
                                20,
                                21,
                                22,
                                23
                            ],
                            "dayOfWeek": "SUNDAY"
                        },
                        {
                            "hourSlots": [
                                0,
                                1,
                                2,
                                3,
                                5,
                                6,
                                7,
                                8,
                                9,
                                10,
                                11,
                                12,
                                14,
                                15,
                                16,
                                17,
                                18,
                                19,
                                21,
                                22,
                                23
                            ],
                            "dayOfWeek": "TUESDAY"
                        },
                        {
                            "hourSlots": [
                                0,
                                1,
                                2,
                                3,
                                4,
                                5,
                                6,
                                7,
                                8,
                                9,
                                10,
                                11,
                                12,
                                13,
                                14,
                                15,
                                16,
                                17,
                                18,
                                19,
                                20,
                                21,
                                22,
                                23
                            ],
                            "dayOfWeek": "WEDNESDAY"
                        },
                        {
                            "hourSlots": [
                                0,
                                1,
                                3,
                                4,
                                5,
                                6,
                                7,
                                8,
                                9,
                                10,
                                12,
                                13,
                                14,
                                15,
                                16,
                                18,
                                19,
                                20,
                                21,
                                22,
                                23
                            ],
                            "dayOfWeek": "THURSDAY"
                        },
                        {
                            "hourSlots": [
                                0,
                                1,
                                2,
                                3,
                                4,
                                5,
                                6,
                                7,
                                8,
                                9,
                                10,
                                11,
                                12,
                                13,
                                14,
                                15,
                                16,
                                17,
                                18,
                                19,
                                20,
                                21,
                                22,
                                23
                            ],
                            "dayOfWeek": "FRIDAY"
                        },
                        {
                            "hourSlots": [
                                0,
                                1,
                                2,
                                3,
                                4,
                                5,
                                6,
                                8,
                                9,
                                10,
                                11,
                                12,
                                13,
                                14,
                                15,
                                16,
                                17,
                                18,
                                19,
                                20,
                                21,
                                22,
                                23
                            ],
                            "dayOfWeek": "SATURDAY"
                        }
                    ]
                },
                "domainListTargeting": {
                    "inheritFromAdvertiser": true
                },
                "deviceTypeTargeting": "DESKTOP_AND_MOBILE",
                "siteLanguageTargeting": "ES",
                "contentTargeting": [
                    "3487**********2680",
                    "3099**********1246",
                    "3221**********5754",
                    "2895**********2704",
                    "3151**********2995"
                ],
                "contextualTargeting": false
            }
        },
        "budget": {
            "budgetCaps": [
                {
                    "amount": 1.0,
                    "recurrenceTimePeriod": "DAILY"
                },
                {
                    "amount": 13.0,
                    "recurrenceTimePeriod": "MONTHLY"
                }
            ],
            "pacing": {
                "deliveryProfile": "EVENLY",
                "catchUpBoost": "CATCH_UP_BOOST_2X"
            }
        },
        "appliedFees": {
            "thirdPartyFees": [
                {
                    "providerName": "INTEGRAL_AD_SCIENCE",
                    "feeAmount": 0.4,
                    "feeAllocation": "ABSORB_WITH_AGENCY_FEE"
                },
                {
                    "providerName": "DOUBLE_VERIFY",
                    "feeAmount": 0.5,
                    "feeAllocation": "PASS_TO_ADVERTISER"
                },
                {
                    "providerName": "DOUBLE_CLICK_CAMPAIGN_MANAGER",
                    "feeAmount": 0.6,
                    "feeAllocation": "ABSORB_WITH_AGENCY_FEE"
                },
                {
                    "providerName": "COM_SCORE",
                    "feeAmount": 0.7,
                    "feeAllocation": "PASS_TO_ADVERTISER"
                },
                {
                    "providerName": "CPM_1",
                    "feeAmount": 0.8,
                    "feeAllocation": "ABSORB_WITH_AGENCY_FEE"
                },
                {
                    "providerName": "CPM_2",
                    "feeAmount": 0.9,
                    "feeAllocation": "ABSORB_WITH_AGENCY_FEE"
                },
                {
                    "providerName": "CPM_3",
                    "feeAmount": 0.2,
                    "feeAllocation": "ABSORB_WITH_AGENCY_FEE"
                }
            ]
        },
        "bidding": {
            "baseSupplyBid": 1.5,
            "maxSupplyBid": 5.0
        },
        "optimization": {
            "budgetOptimization": true
        }
    }
]

更新订单项

您将使用订单项资源的 PUT 操作来更新与您通过标识符指定的订单项相关联的值。您必须提交完整的的订单项资源,其中包含要更新的字段的字段值,其余字段保持不变。

首先,使用订单项资源的 GET 操作来检索您要更新的订单项。

接下来,更新您希望更新的各个字段值。最后,使用订单项资源的 PUT 操作来更新订单项。