List information about the requested instance

请求参数

Header 参数

Amazon-Advertising-API-ClientId

string

必需

(Required) The identifier of a client associated with an Amazon Developer account.

示例值:

Amazon-Advertising-API-MarketplaceId

string

必需

(Required) The marketplace identifier for the marketplace in the request. Marketplaces are tied to the country.

示例值:

Amazon-Advertising-API-AdvertiserId

string

必需

(Required) Your Amazon Ads account executive would have provided you this identifier when you onboarded AMC. Alternatively, access the AMC console with your user identifier and password, and grab the entity identifier value that is displayed in the URL. The alphanumeric code that is prefixed with ENTITY is your account identifier. An example of an entity identifier is: ENTITY1AA1AA11AAA1.

示例值:

Authorization

string

必需

示例值:

Bearer {{access_token}}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://www.amazon.com/ap/oa/amc/instances/{{instanceId}}' \
--header 'Amazon-Advertising-API-ClientId: {{client_id}}' \
--header 'Amazon-Advertising-API-MarketplaceId: {{marketplace_id}}' \
--header 'Amazon-Advertising-API-AdvertiserId: {{advertiser_id}}' \
--header 'Authorization: Bearer {{access_token}}'

返回响应

🟢200Gets information about the requested AMC instance.

application/json

Body

instance

object

必需

instanceId

string

必需

instanceName

string

必需

instanceType

string

必需

customerCanonicalName

string

必需

creationStatus

string

必需

creationDatetime

string

必需

s3BucketName

string

必需

awsAccountId

string

必需

entities

array[string]

必需

dataUploadAwsAccountId

string

必需

apiEndpoint

string

必需

acrCollaboration

null

必需

optionalDatasets

array [object {2}]

必需

advertiserTypes

array[string]

必需

示例

{
    "instance": {
        "instanceId": "amcr1aaaa1a",
        "instanceName": "myinstance",
        "instanceType": "STANDARD",
        "customerCanonicalName": "Sample Instance",
        "creationStatus": "COMPLETED",
        "creationDatetime": "2024-03-29T08:12:11.572511Z",
        "s3BucketName": "amc-sample-instance-bucket",
        "awsAccountId": "",
        "entities": [
            "NA"
        ],
        "dataUploadAwsAccountId": "811639200769",
        "apiEndpoint": "https://advertising-api.amazon.com",
        "acrCollaboration": null,
        "optionalDatasets": [
            {
                "label": "CASPIAN_DIM_CUTOVER",
                "activationTime": "2024-03-27T12:07:25.614Z"
            },
            {
                "label": "CASPIAN_DIM_CUTOVER_CONVERSIONS",
                "activationTime": "2024-03-27T12:07:25.614Z"
            },
            {
                "label": "CASPIAN_FACT_CUTOVER",
                "activationTime": "2024-03-27T12:07:25.614Z"
            },
            {
                "label": "CASPIAN_ONLY",
                "activationTime": "2024-03-27T12:07:25.614Z"
            },
            {
                "label": "CONVERSIONS_EXPOSURE_V3",
                "activationTime": "2024-06-27T13:51:29.259Z"
            }
        ],
        "advertiserTypes": [
            "DISPLAY",
            "SPONSORED_ADS"
        ]
    }
}