DocumentatieExperience PlatformHandleiding voor bestemmingen

Doelgegevens bijwerken met de Flow Service API

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Beheerder
  • Gebruiker

Deze zelfstudie behandelt de stappen voor het bijwerken van een doelgegevensstroom. Leer hoe te om dataflow toe te laten of onbruikbaar te maken, zijn basisinformatie bij te werken, of publiek en attributen toe te voegen en te verwijderen gebruikend Flow Service API. Voor informatie bij het uitgeven van bestemmingsdataflows die het Experience Platform UI gebruiken, lees activeringsstromenuitgeven.

Aan de slag get-started

Voor deze zelfstudie hebt u een geldige stroom-id nodig. Als u geen geldige stroom identiteitskaart hebt, selecteer uw bestemming van keus van de bestemmingscatalogusen volg de stappen die aan worden geschetst verbinden met de bestemmingen activeren gegevensalvorens dit leerprogramma te proberen.

NOTE
De termen stroom en dataflow worden gebruikt onderling verwisselbaar in dit leerprogramma. In de context van deze zelfstudie hebben ze dezelfde betekenis.

Voor deze zelfstudie hebt u ook een goed inzicht nodig in de volgende onderdelen van Adobe Experience Platform:

  • Doelen: Destinations zijn pre-gebouwde integratie met bestemmingsplatforms die voor de naadloze activering van gegevens van Adobe Experience Platform toestaan. U kunt bestemmingen gebruiken om uw bekende en onbekende gegevens voor kanaalmarketing campagnes, e-mailcampagnes, gerichte reclame, en vele andere gebruiksgevallen te activeren.
  • Sandboxes: Experience Platform verstrekt virtuele zandbakken die één enkele instantie van het Platform in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

De volgende secties bevatten aanvullende informatie die u moet weten om uw gegevensstroom met de Flow Service API te kunnen bijwerken.

API-voorbeeldaanroepen lezen reading-sample-api-calls

Deze zelfstudie biedt voorbeeld-API-aanroepen om aan te tonen hoe uw verzoeken moeten worden opgemaakt. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te om voorbeeld API vraagin de het oplossen van problemengids van het Experience Platform te lezen.

Waarden verzamelen voor vereiste koppen gather-values-for-required-headers

Om vraag aan Platform APIs te maken, moet u het authentificatieleerprogrammaeerst voltooien. Het voltooien van de autorisatiezelfstudie biedt de waarden voor elk van de vereiste headers in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Alle bronnen in Experience Platform, inclusief die van Flow Service, zijn geïsoleerd naar specifieke virtuele sandboxen. Alle aanvragen voor platform-API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Als de header x-sandbox-name niet is opgegeven, worden aanvragen opgelost onder de sandbox prod .

Alle verzoeken die een nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra media type kopbal:

  • Content-Type: application/json

Gegevens over gegevensstroom opzoeken look-up-dataflow-details

De eerste stap in het bijwerken van uw bestemmingsgegevensstroom is dataflow details terug te winnen gebruikend uw stroom ID. U kunt de huidige details van een bestaande gegevensstroom bekijken door een verzoek van de GET aan het /flows eindpunt te richten.

API formaat

GET /flows/{FLOW_ID}
Parameter
Beschrijving
{FLOW_ID}
De unieke id -waarde voor de doelgegevensstroom die u wilt ophalen.

Verzoek

Met het volgende verzoek wordt informatie over uw flow-id opgehaald.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een succesvolle reactie keert de huidige details van uw gegevensstroom met inbegrip van zijn versie, uniek herkenningsteken (id), en andere relevante informatie terug.

{
   "items":[
      {
         "id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
         "createdAt":"{CREATED_AT}",
         "updatedAt":"{UPDATED_BY}",
         "createdBy":"{CREATED_BY}",
         "updatedBy":"{UPDATED_BY}",
         "createdClient":"{CREATED_CLIENT}",
         "updatedClient":"{UPDATED_CLIENT}",
         "sandboxId":"{SANDBOX_ID}",
         "sandboxName":"prod",
         "imsOrgId":"{ORG_ID}",
         "name":"2021 winter campaign",
         "description":"ACME company holiday campaign for high fidelity customers",
         "flowSpec":{
            "id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
            "version":"1.0"
         },
         "state":"enabled",
         "version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "sourceConnectionIds":[
            "5e45582a-5336-4ea1-9ec9-d0004a9f344a"
         ],
         "targetConnectionIds":[
            "8ce3dc63-3766-4220-9f61-51d2f8f14618"
         ],
         "inheritedAttributes":{
            "sourceConnections":[
               {
                  "id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
                  "connectionSpec":{
                     "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
                     "connectionSpec":{
                        "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                        "version":"1.0"
                     }
                  },
                  "typeInfo":{
                     "type":"ProfileFragments",
                     "id":"ups"
                  }
               }
            ],
            "targetConnections":[
               {
                  "id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
                  "connectionSpec":{
                     "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
                     "connectionSpec":{
                        "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                        "version":"1.0"
                     }
                  }
               }
            ]
         },
         "transformations":[
            {
               "name":"GeneralTransform",
               "params":{
                  "profileSelectors":{
                     "selectors":[
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"Email",
                              "operator":"EXISTS",
                              "identity":{
                                 "namespace":"Email"
                              },
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"Email",
                                 "destination":"Email",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"Email",
                                 "destinationXdmPath":"Email"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.firstName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.firstName",
                                 "destination":"person.name.firstName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.firstName",
                                 "destinationXdmPath":"person.name.firstName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.lastName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.lastName",
                                 "destination":"person.name.lastName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.lastName",
                                 "destinationXdmPath":"person.name.lastName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"personalEmail.address",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"personalEmail.address",
                                 "destination":"personalEmail.address",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"personalEmail.address",
                                 "destinationXdmPath":"personalEmail.address"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"segmentMembership.status",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"segmentMembership.status",
                                 "destination":"segmentMembership.status",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"segmentMembership.status",
                                 "destinationXdmPath":"segmentMembership.status"
                              }
                           }
                        }
                     ],
                     "mandatoryFields":[
                        "Email",
                        "person.name.firstName",
                        "person.name.lastName"
                     ],
                     "primaryFields":[
                        {
                           "identityNamespace":"Email",
                           "fieldType":"IDENTITY"
                        }
                     ]
                  },
                  "segmentSelectors":{
                     "selectors":[
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"9f7d37fd-7039-4454-94ef-2b0cd6c3206a",
                              "name":"Interested in Mountain Biking",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"ONCE",
                                 "startDate":"2021-12-25",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"f52a3785-2e7c-40a7-8137-9be99af7794e",
                              "name":"Birth year 1970",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"6caa79b9-39e0-4c37-892b-5061cdca2377",
                              "name":"Account Leads",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
                              "name":"Batch export for autumn campaign",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"EVERY_6_HOURS",
                                 "startDate":"2022-01-05",
                                 "endDate":"2022-12-30",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        }
                     ]
                  }
               }
            }
         ]
      }
   ]

Naam en beschrijving van gegevensstroom bijwerken update-dataflow

Als u de naam en beschrijving van uw gegevensstroom wilt bijwerken, moet u een aanvraag voor PATCH uitvoeren naar de API van Flow Service en tegelijkertijd de stroom-id, -versie en de nieuwe waarden opgeven die u wilt gebruiken.

IMPORTANT
De header If-Match is vereist wanneer een PATCH-aanvraag wordt ingediend. De waarde voor deze kopbal is de unieke versie van dataflow u wilt bijwerken. De labelwaarde wordt bijgewerkt bij elke geslaagde update van een gegevensstroom.

API formaat

PATCH /flows/{FLOW_ID}

Verzoek

De volgende aanvraag werkt de naam en beschrijving van uw gegevensstroom bij.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
            {
                "op": "replace",
                "path": "/name",
                "value": "2021/2022 winter campaign"
            },
            {
                "op": "replace",
                "path": "/description",
                "value": "ACME company holiday campaign for high fidelity customers and prospects"
            }
        ]'
Eigenschap
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om dataflow bij te werken. Bewerkingen zijn: add , replace en remove .
path
Definieert het deel van de flow dat moet worden bijgewerkt.
value
De nieuwe waarde waarmee u de parameter wilt bijwerken.

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Dataflow in- of uitschakelen enable-disable-dataflow

Wanneer toegelaten, voert een dataflow profielen naar de bestemming uit. Gegevensstromen zijn standaard ingeschakeld, maar kunnen worden uitgeschakeld om het exporteren van het profiel te pauzeren.

U kunt een bestaande doelgegevensstroom in- of uitschakelen door een POST-aanvraag in te dienen bij de Flow Service API en een status op te geven waarnaar u de stroom wilt bijwerken.

API formaat

POST /flows/{FLOW_ID}/action?op=enable or disable

Verzoek

Met de volgende aanvraag wordt de status van uw gegevensstroom bijgewerkt naar ingeschakeld.

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=enable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Met de volgende aanvraag wordt de status van uw gegevensstroom bijgewerkt naar uitgeschakeld.

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=disable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Een publiek toevoegen aan een gegevensstroom add-segment

Als u een publiek wilt toevoegen aan de doelgegevensstroom, voert u een PATCH-verzoek uit naar de Flow Service -API terwijl u uw stroom-id, versie en publiek opgeeft die u wilt toevoegen.

API formaat

PATCH /flows/{FLOW_ID}

Verzoek

Met het volgende verzoek voegt u een nieuw publiek toe aan een bestaande doelgegevensstroom.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"add",
      "path":"/transformations/0/params/segmentSelectors/selectors/-",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"2d79d0d8-724f-49fc-a09d-d1dec338c93c",
            "name":"Winter 2021/2022 campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%SEGMENT_NAME%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"DAILY_FULL_EXPORT",
            "schedule":{
               "startDate":"2022-01-05",
               "frequency":"DAILY",
               "triggerType": "AFTER_SEGMENT_EVAL",
               "endDate":"2022-03-10"
            }
         }
      }
   }
]'
Eigenschap
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om dataflow bij te werken. Bewerkingen zijn: add , replace en remove . Als u een publiek aan een gegevensstroom wilt toevoegen, gebruikt u de bewerking add .
path
Definieert het deel van de flow dat moet worden bijgewerkt. Wanneer u een publiek aan een gegevensstroom toevoegt, gebruikt u het pad dat in het voorbeeld is opgegeven.
value
De nieuwe waarde waarmee u de parameter wilt bijwerken.
id
Geef de id op van het publiek dat u aan de doelgegevensstroom toevoegt.
name
(Facultatief). Geef de naam op van het publiek dat u aan de doelgegevensstroom toevoegt. Dit veld is niet verplicht en u kunt een publiek toevoegen aan de doelgegevensstroom zonder de naam ervan op te geven.
filenameTemplate

Voor partijbestemmingen slechts. Dit veld is alleen vereist wanneer u een publiek toevoegt aan een gegevensstroom in exportdoelen voor batchbestanden, zoals Amazon S3, SFTP of Azure Blob.
Dit veld bepaalt de bestandsnaamindeling van de bestanden die naar uw doel worden geëxporteerd.
De volgende opties zijn beschikbaar:

  • %DESTINATION_NAME%: verplicht. De geëxporteerde bestanden bevatten de doelnaam.
  • %SEGMENT_ID%: verplicht. De geëxporteerde bestanden bevatten de id van het geëxporteerde publiek.
  • %SEGMENT_NAME%: (Facultatief). De geëxporteerde bestanden bevatten de naam van het geëxporteerde publiek.
  • DATETIME(YYYYMMdd_HHmmss) of %TIMESTAMP%: (Optioneel) . Selecteer één van deze twee opties voor uw dossiers om de tijd te omvatten wanneer zij door Experience Platform worden geproduceerd.
  • custom-text: (Facultatief). Vervang deze tijdelijke aanduiding door aangepaste tekst die u aan het einde van de bestandsnamen wilt toevoegen.

voor meer informatie over het vormen van dossiernamen, verwijs naar vormen dossiernamensectie in de de activeringsleerprogramma van partijbestemmingen.

exportMode
Voor partijbestemmingen slechts. Dit veld is alleen vereist wanneer u een publiek toevoegt aan een gegevensstroom in exportdoelen voor batchbestanden, zoals Amazon S3, SFTP of Azure Blob.
Verplicht. Selecteer "DAILY_FULL_EXPORT" of "FIRST_FULL_THEN_INCREMENTAL" . Voor meer informatie over de twee opties, verwijs naar uitvoer volledige dossiersen de uitvoer stijgende dossiersin het leerprogramma van de de activering van partijbestemmingen.
startDate
Selecteer de datum waarop het publiek moet beginnen met het exporteren van profielen naar uw bestemming.
frequency

Voor partijbestemmingen slechts. Dit veld is alleen vereist wanneer u een publiek toevoegt aan een gegevensstroom in exportdoelen voor batchbestanden, zoals Amazon S3, SFTP of Azure Blob.
Verplicht.

  • Voor de exportmodus "DAILY_FULL_EXPORT" kunt u ONCE of DAILY selecteren.
  • Voor de exportmodus "FIRST_FULL_THEN_INCREMENTAL" kunt u "DAILY" , "EVERY_3_HOURS" , "EVERY_6_HOURS" , "EVERY_8_HOURS" en "EVERY_12_HOURS" selecteren.
triggerType

Voor partijbestemmingen slechts. Dit veld is alleen vereist wanneer u de modus "DAILY_FULL_EXPORT" in de kiezer van frequency selecteert.
Verplicht.

  • Selecteer "AFTER_SEGMENT_EVAL" om de activeringstaak direct uit te voeren nadat de dagelijkse batchsegmentatietaak van het Platform is voltooid. Dit zorgt ervoor dat wanneer de activeringstaak wordt uitgevoerd, de meest recente profielen naar uw bestemming worden uitgevoerd.
  • Selecteer "SCHEDULED" om de activeringstaak op een vast tijdstip uit te voeren. Dit zorgt ervoor dat de gegevens van het Experience Platform profielgegevens tezelfdertijd elke dag worden uitgevoerd, maar de profielen u uitvoert kunnen niet de meest bijgewerkte zijn, afhankelijk van of de batch-segmentatietaak heeft voltooid alvorens de activeringstaak begint. Als u deze optie selecteert, moet u ook een startTime toevoegen om aan te geven op welk tijdstip in UTC de dagelijkse export moet plaatsvinden.
endDate
Voor partijbestemmingen slechts. Dit veld is alleen vereist wanneer u een publiek toevoegt aan een gegevensstroom in exportdoelen voor batchbestanden, zoals Amazon S3, SFTP of Azure Blob.
Niet van toepassing bij het selecteren van "exportMode":"DAILY_FULL_EXPORT" en "frequency":"ONCE" .
Hiermee stelt u de datum in waarop publieksleden stoppen met exporteren naar het doel.
startTime
Voor partijbestemmingen slechts. Dit veld is alleen vereist wanneer u een publiek toevoegt aan een gegevensstroom in exportdoelen voor batchbestanden, zoals Amazon S3, SFTP of Azure Blob.
Verplicht. Selecteer het tijdstip waarop bestanden met leden van het publiek moeten worden gegenereerd en geëxporteerd naar uw bestemming.

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Een publiek verwijderen uit een gegevensstroom remove-segment

Als u een publiek wilt verwijderen uit een bestaande doelgegevensstroom, voert u een PATCH-verzoek uit naar de Flow Service -API en geeft u uw flow-id, versie en de indexkiezer op van het publiek dat u wilt verwijderen. Indexering begint bij 0 . Het voorbeeldverzoek hieronder verwijdert bijvoorbeeld het eerste en het tweede publiek uit de dataflow.

API formaat

PATCH /flows/{FLOW_ID}

Verzoek

Het volgende verzoek verwijdert twee publiek uit een bestaande bestemmingsdataflow.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
{
   "op":"remove",
   "path":"/transformations/0/params/segmentSelectors/selectors/0",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
},
{
   "op":"remove",
   "path":"/transformations/0/params/segmentSelectors/selectors/1",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
}
]'
Eigenschap
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om dataflow bij te werken. Bewerkingen zijn: add , replace en remove . Als u een publiek uit een gegevensstroom wilt verwijderen, gebruikt u de bewerking remove .
path
Geeft aan welk bestaand publiek uit de doelgegevensstroom moet worden verwijderd op basis van de index van de publiekskiezer. Als u de volgorde van het publiek in een gegevensstroom wilt opvragen, voert u een aanroep van de GET naar het eindpunt /flows uit en inspecteert u de eigenschap transformations.segmentSelectors . Als u het eerste publiek in de gegevensstroom wilt verwijderen, gebruikt u "path":"/transformations/0/params/segmentSelectors/selectors/0" .

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Componenten van een publiek in een gegevensstroom bijwerken update-segment

U kunt componenten van een publiek in een bestaande bestemmingsgegevensstroom bijwerken. U kunt bijvoorbeeld de exportfrequentie wijzigen of de sjabloon voor de bestandsnaam bewerken. Hiervoor voert u een PATCH-verzoek uit naar de Flow Service API en verstrekt u uw stroom-id, versie en de indexkiezer van het publiek dat u wilt bijwerken. Indexering begint bij 0 . Met de onderstaande aanvraag wordt bijvoorbeeld het negende publiek in een dataflow bijgewerkt.

API formaat

PATCH /flows/{FLOW_ID}

Verzoek

Wanneer het bijwerken van een publiek in een bestaande bestemmingsdataflow, zou u eerst een GET verrichting moeten uitvoeren om de details van het publiek terug te winnen u wilt bijwerken. Geef vervolgens alle publieksinformatie op in de payload en niet alleen de velden die u wilt bijwerken. In het onderstaande voorbeeld wordt aangepaste tekst toegevoegd aan het einde van de bestandsnaamsjabloon en wordt de frequentie van het exportschema bijgewerkt van 6 uur tot 12 uur.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"replace",
      "path":"/transformations/0/params/segmentSelectors/selectors/8",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
            "name":"Batch export for autumn campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
            "schedule":{
               "frequency":"EVERY_12_HOURS",
               "startDate":"2022-01-05",
               "endDate":"2022-01-30",
               "startTime":"20:00"
            },
            "createTime":"1640289901",
            "updateTime":"1640289901"
         }
      }
   }
]'

Voor beschrijvingen van de eigenschappen in de nuttige lading, verwijs naar de sectie voegt een publiek aan een dataflowtoe.

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Zie de voorbeelden hieronder voor meer voorbeelden van publiekscomponenten die u in een gegevensstroom kunt bijwerken.

Werk de de uitvoerwijze van een publiek van gepland aan na publieksevaluatie bij update-export-mode

Klik om een voorbeeld te zien waarin een publieksexport wordt bijgewerkt van elke dag op een bepaald tijdstip tot elke dag nadat de batchsegmentatietaak van het platform is voltooid.

Het publiek wordt elke dag om 16:00 UTC geëxporteerd.

code language-json 
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

Het publiek wordt elke dag uitgevoerd nadat de dagelijkse batchsegmentatietaak is voltooid.

code language-json 
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "AFTER_SEGMENT_EVAL",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

De bestandsnaamsjabloon bijwerken om extra velden op te nemen in de bestandsnaam update-filename-template

Klik hier om een voorbeeld te zien waarin de bestandsnaamsjabloon wordt bijgewerkt en extra velden in de bestandsnaam worden opgenomen

De geëxporteerde bestanden bevatten de doelnaam en de gebruikers-id van het Experience Platform

code language-json 
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

De geëxporteerde bestanden bevatten de doelnaam, de gebruikers-id van het Experience Platform, de datum en tijd waarop het bestand door het Experience Platform is gegenereerd en aangepaste tekst die aan het einde van de bestanden is toegevoegd.

code language-json 
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_%this is custom text%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

Een profielkenmerk toevoegen aan een gegevensstroom add-profile-attribute

Als u een profielkenmerk aan de doelgegevensstroom wilt toevoegen, voert u een PATCH-aanvraag uit naar de Flow Service -API terwijl u uw flow-id, versie en profielkenmerk opgeeft die u wilt toevoegen.

API formaat

PATCH /flows/{FLOW_ID}

Verzoek

Met de volgende aanvraag wordt een nieuw profielkenmerk toegevoegd aan een bestaande doelgegevensstroom.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"add",
    "path":"/transformations/0/params/profileSelectors/selectors/-",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'
Eigenschap
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om dataflow bij te werken. Bewerkingen zijn: add , replace en remove . Gebruik de bewerking add om een profielkenmerk aan een gegevensstroom toe te voegen.
path
Definieert het deel van de flow dat moet worden bijgewerkt. Wanneer u een profielkenmerk aan een gegevensstroom toevoegt, gebruikt u het pad dat in het voorbeeld is opgegeven.
value.path
De waarde van het profielkenmerk dat u toevoegt aan de gegevensstroom.

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Een profielkenmerk verwijderen uit een gegevensstroom remove-profile-attribute

Als u een profielkenmerk wilt verwijderen uit een bestaande doelgegevensstroom, voert u een PATCH-aanvraag uit naar de Flow Service -API terwijl u uw flow-id, versie en de indexkiezer opgeeft van het profielkenmerk dat u wilt verwijderen. Indexering begint bij 0 . Met de voorbeeldaanvraag hieronder verwijdert u bijvoorbeeld het vijfde profielkenmerk van de gegevensstroom.

API formaat

PATCH /flows/{FLOW_ID}

Verzoek

Met de volgende aanvraag wordt een profielkenmerk verwijderd uit een bestaande doelgegevensstroom.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"remove",
    "path":"/transformations/0/params/profileSelectors/selectors/4",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'
Eigenschap
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om dataflow bij te werken. Bewerkingen zijn: add , replace en remove . Als u een publiek uit een gegevensstroom wilt verwijderen, gebruikt u de bewerking remove .
path
Geeft aan welk bestaand profielkenmerk uit de doelgegevensstroom moet worden verwijderd op basis van de index van de publiekskiezer. Als u de volgorde van profielkenmerken in een gegevensstroom wilt ophalen, voert u een aanroep van de GET naar het eindpunt /flows uit en inspecteert u de eigenschap transformations.profileSelectors . Als u het eerste publiek in de gegevensstroom wilt verwijderen, gebruikt u "path":"transformations/0/params/segmentSelectors/selectors/0/" .

Reactie

Een geslaagde reactie retourneert uw flow-id en een bijgewerkt label. U kunt de update verifiëren door een verzoek om GET te richten aan de Flow Service API, terwijl het verstrekken van uw stroom ID.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

API-foutafhandeling api-error-handling

De API-eindpunten in deze zelfstudie volgen de algemene beginselen van het API-foutbericht voor Experience Platforms. Verwijs naar API statuscodesen de fouten van de verzoekkopbalin de het oplossen van problemengids van het Platform voor meer informatie bij het interpreteren van foutenreacties.

Volgende stappen next-steps

Aan de hand van deze zelfstudie hebt u geleerd hoe u verschillende componenten van een doelgegevensstroom kunt bijwerken, zoals het toevoegen of verwijderen van soorten publiek of profielkenmerken met de API Flow Service . Voor meer informatie over bestemmingen, zie het overzicht van bestemmingen.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6