התקנה של ספריית לקוח

במאמר הזה מוסבר איך מתקינים ומגדירים ספריית לקוח או REST.

דרישות מוקדמות

לפני שמתקינים ספריית לקוח, צריך להשלים את השלבים במאמר הגדרת גישה ל-API, כולל הגדרת Application Default Credentials ‏ (ADC).

שלבי ההתקנה

במחשב המקומי, מתקינים את ספריית הלקוח הרצויה:

REST

  1. מעדכנים את ה-placeholders בדוגמה הבאה, כמו OPERATING_ACCOUNT_PRODUCT,‏ OPERATING_ACCOUNT_ID ו-AUDIENCE_ID, עם הערכים של החשבון והיעד.
  2. מחליפים את PROJECT_ID במזהה של Google Cloud.
  3. מעתיקים את הדוגמה לשורת הפקודה כדי לשלוח את הבקשה. אפשר להשתמש בדוגמה של שותף נתונים רק אם אתם ניגשים לחשבון התפעולי דרך קישור לשותף. אחרת, אפשר להשתמש בדוגמה Advertiser.

    מפרסם

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so this sample falls back to the command
    # without the --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
    gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If you
    # get scope-related errors when you send the request in the next step,
    # verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
    --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
    --header "x-goog-user-project: PROJECT_ID" \
    --header "Content-Type: application/json" \
    --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
                },
                {
                  "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
                }
              ]
            }
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

    שותף נתונים

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so this sample falls back to the command
    # without the --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
    gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If
    # you get scope-related errors when you send the request in the next
    # step, verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
    --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
    --header "x-goog-user-project: PROJECT_ID" \
    --header "Content-Type: application/json" \
    --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "accountType": "LINKED_ACCOUNT_TYPE",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
                },
                {
                  "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
                }
              ]
            }
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

‎.NET

התקנת ספריית הלקוח

פועלים לפי ההוראות במדריך בנושא התקנה של ספריית לקוח ב-‎.NET כדי להוסיף תלות בספריית הלקוח בפרויקט.

אופציונלי: אפשר להוריד את ספריית כלי העזר ודוגמאות קוד.

  1. משכפלים את המאגר ב-GitHub.

    git clone https://github.com/googleads/data-manager-dotnet.git
    
  2. בפרויקט ‎ .NET, מצהירים על תלות בספריית כלי השירות ProjectReference. מחליפים את PATH_TO_UTILITY_LIBRARY במיקום שבו שיבטתם את מאגר data-manager-dotnet.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
    
  3. כדי לעצב את הנתונים, משתמשים בכלי Formatter בפרויקט .NET.

  4. אפשר לעיין בדוגמאות קוד בספריית המשנה samples או ב-GitHub.

    עוברים לספרייה samples ומשתמשים בפקודה dotnet run כדי לקבל את רשימת הדוגמאות הזמינות.

    dotnet run
    

    כשמריצים דוגמה, מעבירים את הארגומנט --help כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

    dotnet run -- ingest-audience-members --help
    

    כדי לעזור לכם להתחיל עם נתונים לדוגמה, תוכלו להשתמש בקבצים בכתובת samples/sampledata.

Go

התקנת ספריית הלקוח

go get cloud.google.com/go/datamanager/apiv1@latest

מידע נוסף זמין במדריך לספריית הלקוח של Go.

Java

התקנת ספריית הלקוח

פועלים לפי ההוראות במדריך בנושא התקנה של ספריית לקוח ב-Java כדי להוסיף תלות בספריית הלקוח בפרויקט.

אופציונלי: התקנת ספריית כלי השירות

בנוסף לספריית הלקוח, אפשר להתקין את ספריית כלי העזר כדי לקבל עזרה במשימות נפוצות כמו עיצוב והצפנה של נתונים להעברה.

  1. בפרויקט Java, מצהירים על תלות בספריית כלי השירות data-manager-util.

    ‫Gradle:

    implementation 'com.google.api-ads:data-manager-util:0.4.0'
    

    ‫Maven:

    <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>data-manager-util</artifactId>
       <version>0.4.0</version>
    </dependency>
    
  2. כדי לפרמט ולהצפין את הנתונים, משתמשים בכלי השירות UserDataFormatter ו-Encrypter בפרויקט Java.

עיון בדוגמאות קוד

אפשר לעיין בדוגמאות קוד בספריית המשנה data-manager-samples או ב-GitHub.

כדי להריץ דוגמאות:

  1. משכפלים את מאגר GitHub בתג v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-java.git
    
  2. מנווטים לספרייה data-manager-java.

  3. מריצים את הדוגמאות משורת הפקודה באמצעות משימת Gradle‏ run, ומעבירים את הארגומנטים הנדרשים. מעבירים את הארגומנט --help כשמריצים דוגמה כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

    לדוגמה, הפקודה הבאה מריצה את הדוגמה IngestAudienceMembers ומדפיסה הצהרת שימוש:

    ./gradlew data-manager-samples:run \
       --args='IngestAudienceMembers --help'
    

כדי לעזור לכם להתחיל עם נתונים לדוגמה, תוכלו להשתמש בקבצים בכתובת data-manager-samples/src/main/resources/sampledata.

Node.js

התקנת ספריית הלקוח

פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח Node.js כדי להוסיף תלות בספריית הלקוח @google-ads/datamanager בפרויקט.

אופציונלי: התקנת ספריית כלי השירות

בנוסף לספריית הלקוח, אפשר להתקין את ספריית כלי העזר כדי לקבל עזרה במשימות נפוצות כמו עיצוב נתונים להעברה.

  1. בפרויקט Node.js, מכריזים על תלות בספריית כלי השירות @google-ads/datamanager-util:

    npm install @google-ads/datamanager-util
    
  2. כדי לעצב את הנתונים, משתמשים בכלי UserDataFormatter בפרויקט Node.js.

עיון בדוגמאות קוד

אפשר לעיין בדוגמאות קוד בספריית המשנה samples או ב-GitHub.

כדי להריץ דוגמאות:

  1. משכפלים את מאגר GitHub בתג v0.4.1:

    git clone --branch v0.4.1 https://github.com/googleads/data-manager-node.git
    
  2. מנווטים לספרייה data-manager-node.

  3. מתקינים את יחסי התלות להרצת הדוגמאות:

    npm install
    
  4. מריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. מעבירים את הארגומנט --help כשמריצים דוגמה כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

    לדוגמה, הפקודה הבאה מריצה את הדוגמה ingest-audience-members ומדפיסה הצהרת שימוש:

    npm run ingest-audience-members -w samples -- --help
    

כדי לעזור לכם להתחיל עם נתונים לדוגמה, תוכלו להשתמש בקבצים בכתובת samples/sampledata.

PHP

התקנת ספריית הלקוח

פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח של PHP כדי להוסיף תלות בספריית הלקוח googleads/data-manager בפרויקט.

אופציונלי: התקנת ספריית כלי השירות

בנוסף לספריית הלקוח, אפשר להתקין את ספריית כלי העזר כדי לקבל עזרה במשימות נפוצות כמו עיצוב נתונים להעברה.

  1. בקובץ composer.json של פרויקט ה-PHP באותו מארח, מצהירים על תלות בספריית כלי השירות:

    composer require googleads/data-manager-util
    
  2. כדי לעצב את הנתונים, משתמשים בכלי Formatter בפרויקט PHP.

עיון בדוגמאות קוד

אפשר לעיין בדוגמאות קוד בספריית המשנה samples או ב-GitHub.

כדי להריץ דוגמאות:

  1. משכפלים את מאגר GitHub בתג v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-php.git
    
  2. מנווטים לספרייה data-manager-php/samples.

  3. מתקינים את יחסי התלות להרצת הדוגמאות:

    composer install
    
  4. מריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. מעבירים את הארגומנט --help כשמריצים דוגמה כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

    לדוגמה, הפקודה הבאה מריצה את הדוגמה ingest_audience_members ומדפיסה הצהרת שימוש:

    php audiences/ingest_audience_members.php --help
    

כדי לעזור לכם להתחיל עם נתונים לדוגמה, תוכלו להשתמש בקבצים בכתובת samples/sampledata.

Python

התקנת ספריית הלקוח

פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח של Python כדי להוסיף תלות בספריית הלקוח google-ads-datamanager בפרויקט.

אופציונלי: התקנת ספריית כלי השירות

בנוסף לספריית הלקוח, אפשר להתקין את ספריית כלי העזר כדי לקבל עזרה במשימות נפוצות כמו עיצוב והצפנה של נתונים להעברה.

  1. בפרויקט Python, מכריזים על תלות בספריית כלי השירות google-ads-datamanager-util.

    לדוגמה, אם משתמשים בקובץ requirements.txt בפרויקט, מוסיפים את השורה הבאה לקובץ:

    google-ads-datamanager-util==0.4.0
    

    אפשר גם להתקין את ספריית כלי העזר ישירות:

    pip install google-ads-datamanager-util==0.4.0
    
  2. כדי לפרמט ולהצפין את הנתונים, משתמשים בכלי השירות Formatter ו-Encrypter בפרויקט Python.

עיון בדוגמאות קוד

  1. משכפלים את מאגר GitHub בתג v0.4.0:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-python.git
    
  2. מנווטים לספרייה data-manager-python.

  3. מתקינים את יחסי התלות להרצת הדוגמאות:

    pip install -r samples/requirements.txt
    
  4. מריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. מעבירים את הארגומנט --help כשמריצים דוגמה כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

    לדוגמה, הפקודה הבאה מריצה את הדוגמה ingest_audience_members ומדפיסה הצהרת שימוש:

    python3 samples/audiences/ingest_audience_members.py --help
    

כדי לעזור לכם להתחיל עם נתונים לדוגמה, תוכלו להשתמש בקבצים בכתובת samples/sampledata.

Ruby

התקנת ספריית הלקוח

פועלים לפי ההוראות במדריך התקנת ספריית הלקוח של Ruby כדי להוסיף תלות בספריית הלקוח בפרויקט.

השלבים הבאים