Thiết lập quyền truy cập API

Sau đây là cách thiết lập quyền truy cập vào Data Manager API bằng SDK hoặc REST.

Điều kiện tiên quyết

Trước khi có thể sử dụng Data API, hãy đảm bảo bạn có những thông tin sau:

  1. Một dự án trên Google Cloud.
  2. Một Tài khoản Google đáp ứng cả hai tiêu chí sau:
    1. Đã được cấp quyền truy cập vào Data Manager API sau khi bạn điền vào Biểu mẫu thể hiện sự quan tâm đến Data Manager API. Nếu có thể xem trang chi tiết sản phẩm API, tức là bạn có quyền truy cập.
    2. Có quyền serviceusage.services.enable đối với dự án Google Cloud của bạn hoặc có một vai trò bao gồm quyền đó. Ví dụ: roles/ownerroles/serviceusage.serviceUsageAdmin đều có quyền serviceusage.services.enable. Để kiểm tra quyền của bạn, hãy xem phần Xem quyền truy cập hiện tại.

Bật API

Nếu chưa bật, hãy bật Data Manager API bằng cách nhấp vào Bật Data Manager API hoặc làm theo hướng dẫn để thực hiện bước này theo cách thủ công.

Bật Data Manager API

Nếu bạn không tìm thấy Data Manager API hoặc không Bật được Data Manager API, hãy xác minh rằng Tài khoản Google của bạn đáp ứng các điều kiện tiên quyết.

Thiết lập chế độ xác thực

Bạn có thể sử dụng bất kỳ Phương thức xác thực nào tại Google ngoài khoá API. Bạn nên xem xét cách Chọn phương thức xác thực phù hợp cho trường hợp sử dụng của bạn để quyết định xem phương pháp nào phù hợp với trường hợp sử dụng của bạn.

Hai phương thức xác thực phổ biến là tài khoản người dùngtài khoản dịch vụ:

  • Tài khoản người dùng: Đại diện cho những người tương tác trực tiếp với các API và dịch vụ của Google.
  • Tài khoản dịch vụ: Đại diện cho ứng dụng, không phải người dùng. Chúng cho phép các ứng dụng của bạn quản lý hoạt động xác thực và uỷ quyền. Ví dụ: nếu một ứng dụng cần truy cập vào tài nguyên trên Google Cloud.

Quy trình tích hợp của bạn có thể sử dụng Thông tin đăng nhập mặc định của ứng dụng (ADC) để tự động tìm thông tin đăng nhập trong môi trường, nhờ đó bạn không phải thay đổi mã ứng dụng để xác thực.

Chọn Tài khoản người dùng hoặc Mạo danh tài khoản dịch vụ để thiết lập ADC:

Sau đây là các bước xác thực bằng thông tin đăng nhập tài khoản người dùng:

  1. Định cấu hình chế độ cài đặt Nền tảng xác thực của Google cho dự án của bạn.

    1. Mở trang Thương hiệu trong Google Cloud Console.

    2. Chọn dự án của bạn.

    3. Điền thông tin vào biểu mẫu rồi nhấp vào Tạo.

  2. Vì phạm vi Data Manager API là một phạm vi nhạy cảm, nên bạn phải thực hiện các bước sau:

    1. Chuyển đến phần cài đặt Quyền truy cập vào dữ liệu cho dự án của bạn.

    2. Nhấp vào Thêm hoặc xoá phạm vi.

    3. Đánh dấu vào hộp bên cạnh API Trình quản lý dữ liệu trong danh sách các phạm vi, rồi nhấp vào Cập nhật.

    4. Nhấp vào Lưu.

    5. Chuyển đến phần Đối tượng trong Google Cloud Console rồi cập nhật Trạng thái xuất bảnLoại người dùng. Tìm hiểu thêm về các chế độ cài đặt này trong phần Quản lý đối tượng ứng dụng.

  3. Nhấp vào Tạo ứng dụng OAuth2 để tạo một ứng dụng OAuth2 trong dự án hoặc làm theo hướng dẫn để tạo một ứng dụng OAuth2 trên máy tính.

    Tạo ứng dụng OAuth2

    Trong bước cuối cùng, hãy nhấp vào DOWNLOAD CLIENT CONFIGURATION (TẢI CẤU HÌNH MÁY KHÁCH XUỐNG) và ghi lại vị trí tải xuống mà bạn chọn.

  4. Tạo một tệp ADC cục bộ bằng cách chạy lệnh sau. Lệnh này sẽ khởi chạy một quy trình trên web, trong đó bạn được nhắc đăng nhập vào Tài khoản Google mà bạn đang sử dụng với API.

    Thay thế PATH_TO_CLIENT_JSON bằng tên của tệp JSON mà bạn đã tải xuống.

    gcloud auth application-default login \
      --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
      --client-id-file="PATH_TO_CLIENT_JSON"
    
  5. Xác nhận rằng bạn đã thiết lập thông tin đăng nhập chính xác bằng lệnh sau. Nếu thành công, lệnh này sẽ in một mã truy cập vào bảng điều khiển.

    gcloud auth application-default print-access-token
    

Để tìm hiểu thêm về quy trình xác thực và thông tin đăng nhập cho ứng dụng của bạn, hãy xem phần Các phương thức xác thực tại GoogleCách hoạt động của Thông tin xác thực mặc định của ứng dụng.

Thiết lập quyền truy cập vào tài khoản hoạt động

Cấp cho email liên kết với tài khoản người dùng của bạn quyền truy cập vào Destination.

  • Nếu bạn đang sử dụng tài khoản Google Ads hoặc tài khoản đối tác dữ liệu, hãy làm theo hướng dẫn để thêm email của người dùng vào tài khoản.
  • Nếu bạn đang sử dụng tài khoản Display & Video 360, hãy làm theo hướng dẫn để thêm email của người dùng vào tài khoản.

Thiết lập SDK cho ngôn ngữ lập trình của bạn

Trên máy cục bộ, hãy cài đặt SDK mà bạn chọn:

REST

  1. Cập nhật các phần giữ chỗ trong mẫu sau, chẳng hạn như OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_IDAUDIENCE_ID, bằng các giá trị cho tài khoản và đích đến của bạn.
  2. Thay thế PROJECT_ID bằng mã nhận dạng Google Cloud của bạn.
  3. Sao chép mẫu vào dòng lệnh để gửi yêu cầu.

    Xoá thuộc tính linkedAccount của mục trong destinations nếu bạn không truy cập vào operatingAccount bằng một đường liên kết đến sản phẩm đã thiết lập.

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account, the command that specifies
    # --scopes fails. 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": {
            "product": "OPERATING_ACCOUNT_PRODUCT",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "product": "LOGIN_ACCOUNT_PRODUCT",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "product": "LINKED_ACCOUNT_PRODUCT",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

.NET

  1. Tải xuống và trích xuất google-cloud-ads-datamanager-v1-csharp.tar.gz.

  2. Trong dự án .NET, hãy khai báo phần phụ thuộc ProjectReference đối với thư viện Data Manager API. Thay thế PATH_TO_CLIENT_LIBRARY bằng vị trí mà bạn đã trích xuất thư mục google-cloud-ads-datamanager-v1-csharp từ google-cloud-ads-datamanager-v1-csharp.tar.gz.

    <ProjectReference Include="PATH_TO_CLIENT_LIBRARY\Google.Ads.DataManager.V1\Google.Ads.DataManager.V1.csproj" />
    
  3. Không bắt buộc. Tải thư viện tiện ích và mã mẫu.

    1. Tải xuống và trích xuất data-manager-dotnet.tar.gz.

    2. Trong dự án .NET, hãy khai báo một phần phụ thuộc ProjectReference trên thư viện tiện ích. Thay thế PATH_TO_UTILITY_LIBRARY bằng vị trí mà bạn đã trích xuất thư mục data-manager-dotnet từ data-manager-dotnet.tar.gz.

      <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
      
    3. Để định dạng dữ liệu, hãy sử dụng tiện ích Formatter trong dự án .NET của bạn.

    4. Duyệt xem các mã mẫu trong thư mục con samples.

      Để chạy các mẫu mã, hãy đặt biến môi trường DATA_MANAGER_DOTNET_LIB thành vị trí mà bạn đã trích xuất thư mục google-cloud-ads-datamanager-v1-csharp từ google-cloud-ads-datamanager-v1-csharp.tar.gz.

      export DATA_MANAGER_DOTNET_LIB="PATH_TO_CLIENT_LIBRARY"
      

      Thay đổi thành thư mục samples và sử dụng dotnet run để lấy danh sách các mẫu có sẵn.

      dotnet run --framework net8.0
      

      Truyền đối số --help khi chạy một mẫu để in câu lệnh sử dụng với các tham số dự kiến.

      dotnet run --framework net8.0 -- ingest-audience-members --help
      

      Để giúp bạn bắt đầu với một số dữ liệu mẫu, hãy sử dụng tệp tại samples/sampledata/audience_members_1.csv.

Java

  1. Tải và trích xuất google-cloud-ads-datamanager-v1-java.tar.gz.
  2. Chuyển đến thư mục google-cloud-ads-datamanager-v1-java.
  3. Chạy lệnh sau để tạo và phát hành thư viện vào kho lưu trữ Maven cục bộ để dùng với Maven hoặc Gradle.

    ./gradlew -Pversion=0.1.0 install
    
  4. Trong dự án Java, hãy khai báo một phần phụ thuộc vào thư viện Data Manager API.

    Gradle:

    implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.0'
    

    Maven:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. Không bắt buộc. Tải thư viện tiện ích và mã mẫu.

    1. Sao chép kho lưu trữ GitHub.

      git clone https://github.com/googleads/data-manager-java.git
      
    2. Chuyển đến thư mục data-manager-java.

    3. Tạo và xuất bản thư viện tiện ích vào kho lưu trữ Maven cục bộ.

      ./gradlew data-manager-util:install
      
    4. Trong dự án Java, hãy khai báo một phần phụ thuộc vào thư viện tiện ích.

      Gradle:

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

      Maven:

      <dependency>
         <groupId>com.google.api-ads</groupId>
         <artifactId>data-manager-util</artifactId>
         <version>0.1.0</version>
      </dependency>
      
    5. Để định dạng và mã hoá dữ liệu, hãy sử dụng các tiện ích UserDataFormatterEncrypter trong dự án Java của bạn.

    6. Duyệt xem các mã mẫu trong thư mục con data-manager-samples hoặc trên GitHub. Để chạy một mẫu từ dòng lệnh, hãy sử dụng tác vụ run của Gradle.

      Ví dụ: lệnh sau đây chạy mẫu IngestAudienceMembers và in một câu lệnh về cách sử dụng:

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

      Để giúp bạn bắt đầu với một số dữ liệu mẫu, hãy sử dụng tệp tại data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Python

  1. Tải ads-datamanager-v1-py.tar.gz xuống.
  2. Chuyển đến thư mục chứa nội dung tải xuống.
  3. Chạy lệnh sau để tạo thư viện và cung cấp thư viện này cho các dự án khác trong cùng môi trường Python:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. Trong dự án Python, hãy khai báo một phần phụ thuộc vào thư viện Data Manager API. Ví dụ: nếu sử dụng tệp requirements.txt trong dự án, hãy thêm dòng sau vào tệp:

    google-ads-data-manager=0.1.0
    
  5. Không bắt buộc. Tải thư viện tiện ích và mã mẫu.

    1. Tải xuống và trích xuất data-manager-python.tar.gz.
    2. Chuyển đến thư mục data-manager-python.
    3. Để cài đặt thư viện tiện ích trong môi trường Python, hãy chạy lệnh sau:

      pip install .
      
    4. Trong dự án Python, hãy khai báo một phần phụ thuộc vào thư viện tiện ích. Ví dụ: nếu bạn đang sử dụng tệp requirements.txt trong dự án, hãy thêm dòng sau vào tệp:

      google-ads-data-manager-util=0.1.0
      
    5. Để định dạng và mã hoá dữ liệu, hãy sử dụng các tiện ích FormatterEncrypter trong dự án Python của bạn.

    6. Duyệt xem các mã mẫu trong thư mục con samples. Truyền đối số --help khi chạy một mẫu để in câu lệnh sử dụng với các tham số dự kiến.

      Để giúp bạn bắt đầu với một số dữ liệu mẫu, hãy sử dụng tệp tại samples/sampledata/audience_members_1.csv.

Node.js

  1. Tải và trích xuất ads-datamanager-v1-nodejs.tar.gz.
  2. Chuyển đến thư mục ads-datamanager-v1-nodejs.
  3. Chạy các lệnh sau để biên dịch và đóng gói thư viện vào một tệp .tgz để dùng với npm.

    npm install
    npm pack
    

    Các lệnh này sẽ tạo một tệp lưu trữ có tên là google-cloud-datamanager-0.1.0.tgz.

  4. Trong dự án Node.js, hãy khai báo một phần phụ thuộc vào thư viện Data Manager API bằng cách thêm một mục nhập dependencies cho đường dẫn và tên tệp đầy đủ của tệp google-cloud-datamanager-0.1.0.tgz.

PHP

  1. Tải google-cloud-ads-datamanager-v1-php.tar.gz xuống và trích xuất.
  2. Chuyển đến thư mục google-cloud-ads-datamanager-v1-php.
  3. Chạy lệnh sau để giải quyết các phần phụ thuộc cho thư viện:

    composer update --prefer-dist
    
  4. Trong tệp composer.json của dự án PHP trên cùng một máy chủ lưu trữ, hãy khai báo một phần phụ thuộc vào thư viện Data Manager API bằng cách làm theo các bước sau:

    1. Thêm một phần repositories trỏ đến vị trí của thư mục google-cloud-ads-datamanager-v1-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Khai báo một phần phụ thuộc trên thư viện Data Manager API.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. (Không bắt buộc) Tải thư viện tiện ích và mã mẫu.

    1. Tải xuống và trích xuất data-manager-php.tar.gz.
    2. Chuyển đến thư mục data-manager-php.
    3. Chạy lệnh sau để giải quyết các phần phụ thuộc cho thư viện:

      composer update --prefer-dist
      
    4. Trong tệp composer.json của dự án PHP trên cùng một máy chủ lưu trữ, hãy khai báo một phần phụ thuộc vào thư viện tiện ích bằng cách làm theo các bước sau:

      1. Thêm một mục trong phần repositories trỏ đến vị trí của thư mục data-manager-php.

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. Khai báo một phần phụ thuộc vào thư viện tiện ích.

        "require": {
           "googleads/data-manager-util": "@dev"
        }
        

      Để định dạng dữ liệu, hãy sử dụng tiện ích Formatter trong dự án PHP của bạn.

    5. Duyệt xem các mã mẫu trong thư mục con samples. Chạy các mẫu bằng cách thực hiện các bước sau:

      1. Chuyển đến thư mục samples.

      2. Đặt biến môi trường DATA_MANAGER_PHP_LIB thành đường dẫn nơi bạn đã trích xuất thư viện ứng dụng.

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. Chạy lệnh sau để giải quyết các phần phụ thuộc cho thư viện:

        composer update --prefer-dist
        
      4. Chạy các mẫu, truyền mọi đối số bắt buộc. Truyền đối số --help khi chạy một mẫu để in câu lệnh sử dụng với các tham số dự kiến.

      Để giúp bạn bắt đầu với một số dữ liệu mẫu, hãy sử dụng tệp tại samples/sampledata/audience_members_1.csv.

Các bước tiếp theo