Documentatie Experience Platform Handleiding voor bestemmingen

Een publiekssjabloon ophalen

Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Destinations

Gemaakt voor:

Beheerder
Gebruiker

IMPORTANT

API-eindpunt: platform.adobe.io/data/core/activation/authoring/audience-templates

Deze pagina illustreert de API aanvraag en lading die u kunt gebruiken om een malplaatje van publieksmeta-gegevens terug te winnen, gebruikend /authoring/audience-templates API-eindpunt.

Voor een gedetailleerde beschrijving van de mogelijkheden die u door dit eindpunt kunt vormen, zie beheer van metagegevens van het publiek.

IMPORTANT

Alle parameternamen en -waarden die door Destination SDK worden ondersteund, zijn hoofdlettergevoelig. Om fouten in hoofdlettergevoeligheid te voorkomen, gebruikt u de namen en waarden van parameters exact zoals in de documentatie wordt getoond.

Aan de slag met API-bewerkingen voor publiekssjablonen get-started

Controleer voordat je doorgaat de gids Aan de slag voor belangrijke informatie die u moet weten om met succes vraag aan API te maken, met inbegrip van hoe te om de vereiste toestemming van de bestemmings creatie en vereiste kopballen te verkrijgen.

Een publiekssjabloon ophalen retrieve

U kunt een bestaande publiekssjabloon ophalen door een GET verzoek aan de /authoring/audience-templates eindpunt.

API-indeling

Gebruik de volgende API-indeling om alle publiekssjablonen voor uw account op te halen.

GET /authoring/audience-templates

Gebruik de volgende API-indeling om een specifieke publiekssjabloon op te halen, gedefinieerd door de {INSTANCE_ID} parameter.

GET /authoring/audience-templates/{INSTANCE_ID}

De volgende twee verzoeken winnen alle publiekssjablonen voor uw IMS Organisatie, of een specifiek publiekssjabloon terug, afhankelijk van of u overgaan INSTANCE_ID in de aanvraag.

Selecteer hieronder elk tabblad om de bijbehorende lading weer te geven.

Alle publiekssjablonen ophalen

Het volgende verzoek zal de lijst van publiekssjablonen terugwinnen die u toegang hebt, gebaseerd op IMS Org ID en sandboxconfiguratie.

accordion

verzoek

code language-shell

curl -X GET https://platform.adobe.io/data/core/activation/authoring/audience-templates \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

accordion

Response

Een geslaagde reactie retourneert HTTP-status 200 met een lijst van publiekssjablonen waartoe u toegang hebt, op basis van de IMS Org ID en naam van sandbox die u hebt gebruikt. Eén instanceId komt overeen met één publiekssjabloon.

code language-json

{
   "instanceId":"34ab9cc2-2536-44a5-9dc5-b2fea60b3bd6",
   "createdDate":"2021-07-26T19:30:52.012490Z",
   "lastModifiedDate":"2021-07-27T21:25:42.763478Z",
   "metadataTemplate":{
      "create":{
         "url":"https://api.moviestar.com/v1/adaccounts/{{customerData.accountId}}/segments",
         "httpMethod":"POST",
         "headers":[
            {
               "value":"application/json",
               "header":"Content-Type"
            },
            {
               "value":"Bearer {{oauth2ServiceAccessToken}}",
               "header":"Authorization"
            }
         ],
         "requestBody":{
            "json":{
               "segments":[
                  {
                     "name":"{{segment.name}}",
                     "description":"{{segment.description}}",
                     "source_type":"FIRST_PARTY",
                     "ad_account_id":"{{customerData.accountId}}",
                     "retention_in_days":180
                  }
               ]
            }
         },
         "responseFields":[
            {
               "value":"{{body.segments[0].segment.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{root}}",
               "name":"message"
            }
         ]
      },
      "update":{
         "url":"https://adsapi.moviestar.com/v1/adaccounts/{{customerData.accountId}}/segments",
         "httpMethod":"PUT",
         "headers":[
            {
               "value":"application/json",
               "header":"Content-Type"
            },
            {
               "value":"Bearer {{oauth2ServiceAccessToken}}",
               "header":"Authorization"
            }
         ],
         "requestBody":{
            "json":{
               "segments":[
                  {
                     "id":"{{segment.alias}}",
                     "name":"{{segment.name}}",
                     "description":"{{segment.description}}"
                  }
               ]
            }
         },
         "responseFields":[
            {
               "value":"{{body.segments[0].segment.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{root}}",
               "name":"message"
            }
         ]
      },
      "delete":{
         "url":"https://adsapi.moviestar.com/v1/segments/{{segment.alias}}",
         "httpMethod":"DELETE",
         "headers":[
            {
               "value":"application/json",
               "header":"Content-Type"
            },
            {
               "value":"Bearer {{oauth2ServiceAccessToken}}",
               "header":"Authorization"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{root}}",
               "name":"message"
            }
         ]
      },
      "name":"Moviestar destination audience template - Example 1"
   }
}

Een specifieke publiekssjabloon ophalen

Het volgende verzoek zal de lijst van publiekssjablonen terugwinnen die u toegang hebt, gebaseerd op IMS Org ID en sandboxconfiguratie.

accordion

verzoek

code language-shell

curl -X GET https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

table 0-row-2 1-row-2
Parameter	Beschrijving
`{INSTANCE_ID}`	De id van de publiekssjabloon die u wilt ophalen.

accordion

Response

Een geslaagde reactie retourneert HTTP-status 200 met de details van de publiekssjabloon die overeenkomen met de {INSTANCE_ID} verstrekt op de vraag.

code language-json

{
   "instanceId":"34ab9cc2-2536-44a5-9dc5-b2fea60b3bd6",
   "createdDate":"2021-07-26T19:30:52.012490Z",
   "lastModifiedDate":"2021-07-27T21:25:42.763478Z",
   "metadataTemplate":{
      "create":{
         "url":"https://api.moviestar.com/v1/adaccounts/{{customerData.accountId}}/segments",
         "httpMethod":"POST",
         "headers":[
            {
               "value":"application/json",
               "header":"Content-Type"
            },
            {
               "value":"Bearer {{oauth2ServiceAccessToken}}",
               "header":"Authorization"
            }
         ],
         "requestBody":{
            "json":{
               "segments":[
                  {
                     "name":"{{segment.name}}",
                     "description":"{{segment.description}}",
                     "source_type":"FIRST_PARTY",
                     "ad_account_id":"{{customerData.accountId}}",
                     "retention_in_days":180
                  }
               ]
            }
         },
         "responseFields":[
            {
               "value":"{{body.segments[0].segment.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{root}}",
               "name":"message"
            }
         ]
      },
      "update":{
         "url":"https://adsapi.moviestar.com/v1/adaccounts/{{customerData.accountId}}/segments",
         "httpMethod":"PUT",
         "headers":[
            {
               "value":"application/json",
               "header":"Content-Type"
            },
            {
               "value":"Bearer {{oauth2ServiceAccessToken}}",
               "header":"Authorization"
            }
         ],
         "requestBody":{
            "json":{
               "segments":[
                  {
                     "id":"{{segment.alias}}",
                     "name":"{{segment.name}}",
                     "description":"{{segment.description}}"
                  }
               ]
            }
         },
         "responseFields":[
            {
               "value":"{{body.segments[0].segment.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{root}}",
               "name":"message"
            }
         ]
      },
      "delete":{
         "url":"https://adsapi.moviestar.com/v1/segments/{{segment.alias}}",
         "httpMethod":"DELETE",
         "headers":[
            {
               "value":"application/json",
               "header":"Content-Type"
            },
            {
               "value":"Bearer {{oauth2ServiceAccessToken}}",
               "header":"Authorization"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{root}}",
               "name":"message"
            }
         ]
      },
      "name":"Moviestar destination audience template - Example 1"
   }
}

API-foutafhandeling error-handling

Destination SDK API-eindpunten volgen de algemene API-foutberichtbeginselen voor Experience Platforms. Zie API-statuscodes en aanvragen, koptekstfouten in de het oplossen van problemengids van het Platform.

Volgende stappen next-steps

Nadat u dit document hebt gelezen, weet u nu hoe u details over de configuratie van de doelserver kunt ophalen met de /authoring/destination-servers API-eindpunt. Lezen hoe te om Destination SDK te gebruiken om uw bestemming te vormen om te begrijpen waar deze stap in het proces past om uw bestemming te vormen.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6