Migracja z interfejsu Drive API

W tym dokumencie opisujemy, jak przenieść kod korzystający z interfejsu Drive API do zarządzania uprawnieniami do interfejsu Looker Studio API. W przypadku typowych punktów końcowych interfejsu Drive API wyświetla odpowiedni kod interfejsu Looker Studio API.

Pliki

W przypadku punktów końcowych plików interfejsu Drive API interfejs Looker Studio API ma odpowiednik tylko dla punktu końcowego Files: list.

Lista

Interfejs API Metoda Punkt końcowy
Dysk POST /drive/v3/files
Looker Studio GET /v1/assets:search

Porównanie:

Dysk

const oAuthToken = '123' // This should be replaced with a valid OAuth token.
fetch(`https://www.googleapis.com/drive/v3/files`, {
  headers: {
    Authorization: `Bearer ${oAuthToken}`
  },
  method: "POST",
})

Looker Studio

const oAuthToken = '123' // This should be replaced with a valid OAuth token.
fetch(`https://datastudio.googleapis.com/v1/assets:search?assetTypes={ASSET_TYPE}`, {
  headers: {
    Authorization: `Bearer ${oAuthToken}`
  }
})

Zobacz wyszukiwanie zasobów.

Uprawnienia

Tworzenie, usuwanie i pobieranie

Interfejs API Metoda Punkt końcowy
Dysk POST /drive/v3/files/fileId/permissions
Dysk DELETE /drive/v3/files/fileId/permissions/permissionId
Dysk GET /drive/v3/files/fileId/permissions/permissionId

W interfejsie Looker Studio API nie ma odpowiednich punktów końcowych do zarządzania wieloma obiektami Permissions. W przypadku zasobu Looker Studio istnieje tylko jeden obiekt uprawnień, który zawsze jest dostępny.

Lista

Nie ma bezpośredniego odpowiednika między Dyskiem a Looker Studio, ale punkty końcowe służą podobnym celom. Główna różnica polega na tym, że plik na Dysku może mieć wiele obiektów uprawnień, a Looker Studio ma tylko jeden.

Interfejs API Metoda Punkt końcowy
Dysk GET /drive/v3/files/fileId/permissions
Looker Studio GET /v1/assets/assetId/permissions

Porównanie:

Dysk

Poniższy kod zawiera listę wszystkich obiektów uprawnień interfejsu Drive API. W zależności od kodu możesz wywołać tę metodę wiele razy, używając tokenów stronicowania (jak pokazano), aby mieć pewność, że widzisz wszystkie uprawnienia ustawione dla pliku.

const fileId = '123'; // This should be replaced with a valid Drive ID.
const oAuthToken = '123'; // This should be replaced with a valid OAuth token.
let nextPageToken = undefined;
let permissions = [];
do {
  const permissionsData = await fetch(`https://www.googleapis.com/drive/v3/files/${fileId}/permissions`, {
    headers: {
      Authorization: `Bearer ${oAuthToken}`
    }
  });
  nextPageToken = permissionsData.nextPageToken;
  permissions = permissions.concat(permissionsData.permissions)
} while (nextPageToken !== undefined);

Looker Studio

Ponieważ w przypadku zasobu Looker Studio jest tylko 1 obiekt uprawnień, nie musisz uwzględniać paginacji.

const oAuthToken = '123' // This should be replaced with a valid OAuth token.
const assetId = '123' // This should be replaced with a valid asset ID.
fetch(`https://datastudio.googleapis.com/v1/assets/{ASSET_ID}/permissions`, {
  headers: {
    Authorization: `Bearer ${oAuthToken}`
  }
}

Zobacz uzyskiwanie uprawnień.

Aktualizuj

Interfejsy API Studia danych i Dysku mają bardzo podobne funkcje aktualizowania uprawnień. Główna różnica polega na tym, że nie możesz ustawić expirationTime w przypadku uprawnień Looker Studio.

Interfejs API Metoda Punkt końcowy
Dysk PATCH /drive/v3/files/fileId/permissions/permissionId
Looker Studio PATCH /v1/assets/assetId/permissions

Porównanie:

Dysk

const fileId = '123'; // This should be replaced with a valid Drive ID.
const oAuthToken = '123'; // This should be replaced with a valid OAuth token.
const newPermissionsObject = {
  expirationTime: '...',
  role: 'owner', // Or any other option
}
fetch(`https://www.googleapis.com/drive/v3/files/${fileId}/permissions/permissionId`, {
  headers: {
    Authorization: `Bearer ${oAuthToken}`
  },
  method: "PATCH",
  body: JSON.stringify(newPermissionsObject)
})

Looker Studio

const oAuthToken = '123' // This should be replaced with a valid OAuth token.
const assetId = '123' // This should be replaced with a valid asset ID.
const newPermissionsObject = {
  permissions: {
    //...
  }
}

fetch(`https://datastudio.googleapis.com/v1/assets/${assetId}/permissions`, {
  headers: {
    Authorization: `Bearer ${oAuthToken}`
  },
  method: "PATCH",
  body: JSON.stringify({
    name: assetId,
    permissions: newPermissionsObject
  })
})

Alternatywne rozwiązania w konkretnych przypadkach użycia znajdziesz w tych artykułach: