Tworzenie listy odbiorców z kierowania na listę klientów

Utwórz listę odbiorców kierowania na listę klientów, wysyłając CreateUserListRequest.

Tworzenie treści żądania

Utwórz zasób UserList. Oto typowe pola, które należy ustawić.

displayName

Wymagane. Wyświetlana nazwa listy. Nazwa musi być unikalna wśród wszystkich list należących do konta.

description

Krótki opis listy.

integrationCode

Identyfikator z Twojego systemu.

membershipDuration

Czas, przez jaki odbiorca pozostaje na liście po dodaniu. Wartość musi odpowiadać pełnym dniom. Jeśli nie jest ustawiona, przyjmuje się domyślnie wartość maksymalną.

Jeśli używasz formatu JSON, oblicz liczbę sekund, mnożąc liczbę dni trwania przez 86400 (liczbę sekund w ciągu dnia). Następnie ustaw wartość na wynik mnożenia, a potem wpisz s. Jeśli na przykład chcesz, aby okres członkostwa wynosił 90 dni, użyj wartości 7776000s, ponieważ 90 * 86400 = 7776000.

Jeśli używasz formatu bufora protokołu, skorzystaj z metody ułatwiającej tworzenie obiektu Duration na podstawie liczby dni, jeśli taka metoda istnieje. Na przykład protobuf-java-util biblioteka Java ma wygodną metodę fromDays(). W przeciwnym razie oblicz liczbę sekund, mnożąc liczbę dni trwania przez 86400 (liczbę sekund na dzień), a następnie użyj wyniku, aby ustawić pole seconds obiektu Duration.

Pola wymagane w przypadku kierowania na listę klientów

W przypadku odbiorców kierowania na listę klientów pole ingestedUserListInfo jest wymagane.

Oto pola, które należy ustawić w IngestedUserListInfo w zależności od typu danych, których chcesz użyć do dodania odbiorców do listy.

Lista informacji kontaktowych

Jeśli chcesz używać informacji kontaktowych (zaszyfrowanych adresów e-mail, numerów telefonów lub adresów) do określania odbiorców, ustaw te pola:

uploadKeyTypes

Ustaw na listę zawierającą typ klucza przesyłania CONTACT_ID.

Lista uploadKeyTypes musi zawierać tylko jeden wpis.

contactIdInfo

Ustaw na wartość ContactIdInfo komunikatu z parametrem dataSourceType ustawionym na odpowiednią wartość z wyliczenia DataSourceType.

Lista identyfikatorów Mobile ID

Jeśli chcesz używać identyfikatorów mobilnych do definiowania członków odbiorców, ustaw te pola:

uploadKeyTypes

Ustaw na listę zawierającą typ klucza przesyłania MOBILE_ID.

Lista uploadKeyTypes musi zawierać tylko jeden wpis.

mobileIdInfo

Ustaw na wiadomość:MobileIdInfo

• Ustaw dataSourceType na odpowiednią wartość z wyliczenia DataSourceType.

• Ustaw wartość keySpace na IOS lub ANDROID.

• Ustaw wartość parametru appId na ciąg znaków, który jednoznacznie identyfikuje aplikację mobilną, z której zebrano dane.

  • W przypadku iOS ciąg znaków identyfikatora to 9-cyfrowy ciąg znaków, który pojawia się na końcu adresu URL App Store. Na przykład 476943146 w przypadku aplikacji „Flood-It!” z linkiem do App Store https://apps.apple.com/us/app/flood-it/id476943146.

  • W przypadku Androida ciągiem znaków identyfikatora jest nazwa pakietu aplikacji. Na przykład com.labpixies.flood w przypadku aplikacji „Flood-It!” z linkiem do Google Play https://play.google.com/store/apps/details?id=com.labpixies.flood.

Tworzenie żądania

Aby utworzyć listę odbiorców kierowania na listę klientów, utwórz create żądanie zasobu UserList.

1. W polu parent ustaw nazwę zasobu konta. Nazwa zasobu musi mieć format accountTypes/{accountType}/accounts/{account}.

2. Użyj obiektu UserList utworzonego na potrzeby treści żądania.

3. Jeśli Twoje dane logowania nie dotyczą konta Google, które jest użytkownikiem w parent, ustaw nagłówki zgodnie z opisem w sekcji Konfigurowanie miejsc docelowych i nagłówków.

Oto przykładowe żądania w formacie JSON dotyczące różnych rodzajów informacji o użytkownikach. W każdym żądaniu wartość parametru membershipDuration jest ustawiana na 2592000s, gdzie 2592000 to liczba sekund w 30 dniach. Aby wypróbować żądanie, kliknij przycisk Otwórz w API Explorer.

{
    "description": "Customer Match for contact info",
    "displayName": "Contact info audience",
    "ingestedUserListInfo": {
        "contactIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "CONTACT_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

{
    "description": "Customer Match for mobile IDs",
    "displayName": "Mobile ID audience",
    "ingestedUserListInfo": {
        "mobileIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY",
            "keySpace": "ANDROID",
            "appId": "com.labpixies.flood"
        },
        "uploadKeyTypes": [
            "MOBILE_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Wysyłanie żądania

Wyślij żądanie i w razie potrzeby dołącz nagłówki żądania.

Jeśli żądanie się powiedzie, odpowiedź będzie zawierać utworzony obiekt UserList z wypełnionymi polami id i name. Zanotuj wartości w tych polach, ponieważ będą Ci potrzebne w przypadku próśb o dodanie do listy odbiorców kolejnych osób.

Jeśli żądanie się nie powiedzie, sprawdź błędy, aby określić przyczynę niepowodzenia. Zaktualizuj żądanie i nagłówki, aby rozwiązać problemy, a następnie wyślij zaktualizowane żądanie i nagłówki.