Zum Hauptinhalt springen

Erste Schritte mit dem blocks lookup endpoint

Dieser Schnellstart-Leitfaden hilft Ihnen, Ihre erste Anfrage an das blocks lookup endpoint mit Postman zu senden. Wenn Sie Beispielcode in verschiedenen Sprachen sehen möchten, besuchen Sie bitte unser GitHub-Repository mit X API v2 Beispielcode.

Voraussetzungen

Um diesen Leitfaden abzuschließen, benötigen Sie einen Satz Keys und Tokens, um Ihre Anfrage zu authentifizieren. Sie können diese Keys und Tokens generieren, indem Sie die folgenden Schritte ausführen:

Schritte zum Erstellen einer Blocks-Lookup-Anfrage

Schritt eins: Beginnen Sie mit einem Tool oder einer Bibliothek

Es gibt verschiedene Tools, Codebeispiele und Bibliotheken, mit denen Sie eine Anfrage an dieses endpoint senden können. Wir verwenden hier Postman, um den Prozess zu vereinfachen. Um die X API v2 Postman-Collection in Ihre Umgebung zu laden, klicken Sie bitte auf die folgende Schaltfläche: Sobald Sie die X API v2-Collection in Postman geladen haben, navigieren Sie zum Ordner „Blocks“ und wählen Sie „Blocks Lookup“.  

Schritt zwei: Authentifizieren Sie Ihre Anfrage

Um eine Anfrage an die X API korrekt zu stellen, müssen Sie Ihre Berechtigung nachweisen. Bei diesem endpoint müssen Sie Ihre Anfrage entweder mit OAuth 1.0a User Context oder OAuth 2.0 Authorization Code with PKCE authentifizieren. In diesem Beispiel verwenden wir OAuth 1.0a User Context. Fügen Sie Ihre Keys und Tokens – konkret Ihren API Key, API Secret Key, OAuth 1.0a user Access Token und OAuth 1.0a user Access Token Secret – in Postman hinzu. Wählen Sie dazu oben rechts in Postman die Umgebung „X API v2“ aus und tragen Sie Ihre Keys und Tokens in die Felder „initial value“ und „current value“ ein (klicken Sie dazu auf das Augensymbol neben der Umgebungs-Dropdown-Liste). Diese Variablen werden automatisch in den Authorization-Tab der Anfrage übernommen, wenn Sie dies korrekt eingerichtet haben.  

Schritt drei: Einen Nutzer angeben

Bei diesem endpoint müssen Sie Ihre user ID oder die user ID eines authentifizierten Nutzers angeben, um zu sehen, wen Sie blockiert haben. In Postman navigieren Sie zur Registerkarte „Params“ und geben diese user ID in die Spalte „Value“ der id-Pfadvariable ein (am unteren Rand des Abschnitts). Achten Sie darauf, vor oder nach Benutzernamen keine Leerzeichen einzufügen.  
KeyValue
id(Ihre user ID)
max_results5

Schritt vier: Ermitteln und angeben, welche fields Sie abrufen möchten

Wenn Sie nach Schritt drei auf die Schaltfläche „Send“ klicken, erhalten Sie in Ihrer Antwort die Standard-User-Objekt-fields: id, name und username. Wenn Sie zusätzliche fields über id, name und username hinaus erhalten möchten, müssen Sie diese fields in Ihrer Anfrage mit den Parametern fields und/oder expansions angeben. Für diese Übung fordern wir drei zusätzliche Sets von fields aus verschiedenen Objekten an:
  1. Das zusätzliche user.created_at-field in den primären User-Objekten.
  2. Die zugehörigen Standard-fields des angehefteten Posts-Objekts für die zurückgegebenen Nutzer: id und text.
  3. Das zusätzliche tweet.created_at-field in den zugehörigen Post-Objekten.
Navigieren Sie in Postman zur Registerkarte „Params“ und fügen Sie der Tabelle „Query Params“ das folgende Schlüssel-Wert-Paar hinzu:
KeyValueReturned fields
user.fieldscreated_atuser.created_at
expansionspinned_tweet_idtweet.id, tweet.text
tweet.fieldscreated_atincludes.tweets.created_at
Sie sollten nun eine ähnliche URL sehen, wobei neben der Schaltfläche „Send“ Ihre eigene Nutzer-id anstelle der URL von TwitterDev angezeigt wird:
      https://api.x.com/2/users/2244994945/blocking?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at

Schritt fünf: Senden Sie Ihre Anfrage und prüfen Sie die Antwort

Sobald alles eingerichtet ist, klicken Sie auf die Schaltfläche „Send“, und Sie erhalten eine ähnliche Antwort wie im folgenden Beispiel:
    {
  "data": [
    {
      "created_at": "2008-12-04T18:51:57.000Z",
      "id": "17874544",
      "username": "TwitterSupport",
      "name": "Twitter Support"
    },
    {
      "created_at": "2007-02-20T14:35:54.000Z",
      "id": "783214",
      "username": "Twitter",
      "name": "Twitter"
    },
    {
      "pinned_tweet_id": "1389270063807598594",
      "created_at": "2018-11-21T14:24:58.000Z",
      "id": "1065249714214457345",
      "username": "TwitterSpaces",
      "name": "Spaces"
    },
    {
      "pinned_tweet_id": "1293595870563381249",
      "created_at": "2007-05-23T06:01:13.000Z",
      "id": "6253282",
      "username": "XAPI",
      "name": "X API"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-05-03T17:26:09.000Z",
        "id": "1389270063807598594",
        "text": "jetzt können alle mit 600 oder mehr Followern einen Space hosten.\n\nbasierend auf unseren Erkenntnissen werden diese Accounts wahrscheinlich eine gute Hosting-Erfahrung machen, da sie bereits über eine Zielgruppe verfügen. bevor wir die Möglichkeit, einen Space zu erstellen, allen zur Verfügung stellen, konzentrieren wir uns auf einige Aspekte. 🧵"
      },
      {
        "created_at": "2020-08-12T17:11:04.000Z",
        "id": "1293595870563381249",
        "text": "X API v2: Early Access veröffentlicht\n\nHeute haben wir Early Access zu den ersten Endpoints der neuen Twitter API angekündigt!\n\n#TwitterAPI #EarlyAccess #VersionBump https://t.co/g7v3aeIbtQ"
      }
    ]
  }

Schritt sechs: Ergebnisse paginieren

Möglicherweise stellen Sie fest, dass sich am Ende der Antwort ein meta-Objekt befindet. Wenn Sie ein next_token erhalten, bedeutet das, dass es eine weitere Seite mit Ergebnissen gibt, die abgerufen werden kann. Um die nächste Ergebnisseite zu laden, nehmen Sie den Wert des Felds next_token und fügen ihn der Anfrage als Wert für einen zusätzlichen Parameter pagination_token hinzu.  
SchlüsselWert
pagination_token1D3PU6DRII9HEZZZ
Wenn Sie die Anfrage nach Hinzufügen dieses zusätzlichen Parameters senden, werden die nächsten fünf Ergebnisse in der nachfolgenden Payload geliefert, da wir in Schritt drei max_results auf 5 festgelegt haben. Sie können diesen Vorgang wiederholen, bis alle Ergebnisse zurückgegeben wurden. Alternativ können Sie den Parameter max_results verwenden, um bis zu 1000 Nutzer pro Anfrage anzufordern, sodass Sie weniger durch die Ergebnisse paginieren müssen.
I